From e97bccc30e64af2c72a0a00aa298089fc1640a4e Mon Sep 17 00:00:00 2001 From: Anubhav Gain Date: Tue, 5 Mar 2024 15:01:49 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0808e99 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing Guidelines + +Thank you for your interest in contributing to the ebpf-file-monitor project! Before you contribute, please review the guidelines below to ensure a smooth and effective contribution process. + +## Getting Started + +To contribute to this project, follow these steps: + +1. Fork the repository on GitHub. +2. Clone your forked repository to your local machine. +3. Make your changes or additions to the codebase. +4. Test your changes thoroughly to ensure functionality and compatibility. +5. Commit your changes (`git commit -am 'Add new feature'`). +6. Push to your forked repository (`git push origin master`). +7. Create a new pull request on GitHub. + +## Guidelines + +- Follow Rust's official coding conventions and style guidelines. +- Ensure your code is well-documented, especially for new features or significant changes. +- Verify that your changes adhere to the project's objectives and align with existing functionality. +- Test your changes on different platforms (Linux, Windows, MacOS) if applicable. +- Keep pull requests focused and limited to a single feature or bug fix. + +## Code Conventions + +- Use proper Rust syntax and idioms in your code. +- Follow consistent naming conventions for variables, functions, and modules. +- Write clear and descriptive comments to explain complex logic or algorithms. +- Use meaningful commit messages that succinctly describe the purpose of each commit. + +## Additional Notes + +- Feel free to open an issue to discuss potential improvements or new features before starting work on them. +- Contributions that enhance the functionality, performance, or usability of the project are highly appreciated. +- If you encounter any bugs or issues, please report them by opening a new issue on GitHub. +- Your contributions help make this project better for everyone. Thank you for your efforts! + +Happy coding! If you have any questions or need further assistance, feel free to reach out via GitHub issues.