From e70f9336e5ffb746266db1bf799f4fc71079ce90 Mon Sep 17 00:00:00 2001 From: Tarun-Manchala Date: Thu, 28 Mar 2024 16:04:49 +0530 Subject: [PATCH 1/2] added Contributing guidelines --- CONTRIBUTING_GUIDE.md | 48 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 CONTRIBUTING_GUIDE.md diff --git a/CONTRIBUTING_GUIDE.md b/CONTRIBUTING_GUIDE.md new file mode 100644 index 000000000000..706f3d4e4cd9 --- /dev/null +++ b/CONTRIBUTING_GUIDE.md @@ -0,0 +1,48 @@ +# Contributing to Watchman + +We welcome contributions from the community! This guide outlines how you can contribute to Watchman. + +## :bulb: Getting Started + +Before you jump in, here are a few things to keep in mind: + +* **Review the codebase:** Familiarize yourself with the project's structure and coding style. +* **Fork the repository:** Create a fork of the repository on [Platform (e.g., GitHub, GitLab)] so you can make your changes. + +## :book: How to Contribute + +There are several ways you can contribute to Watchman: + +* **Bug fixes:** Identify and fix bugs in the existing codebase. +* **Feature enhancements:** Propose and implement new features that improve the project. +* **Documentation improvements:** Help us improve the project's documentation. +* **Code style:** Ensure code adheres to the project's style guide. +* **Testing:** Write unit tests for new code or existing functionality. + +## :lock: Code of Conduct + +Review our **[Code of Conduct](https://github.com/facebook/watchman/blob/main/CODE_OF_CONDUCT.md)** before making any Pull Request + +## :inbox_tray: Making a Pull Request + +1. **Create a new branch:** Create a new branch for your specific contribution. +2. **Make your changes:** Implement your bug fix, feature, or other contribution. +3. **Write unit tests (if applicable):** Add unit tests to cover your changes. +4. **Run tests:** Ensure all tests pass before submitting your pull request. +5. **Commit your changes:** Commit your changes with a clear and concise commit message. +6. **Push your branch:** Push your branch to your forked repository. +7. **Open a pull request:** Open a pull request on the main repository. +8. **Respond to feedback:** Address any feedback or questions from maintainers. + +## :love_letter: Code Style and Formatting + +* Please adhere to the project's coding style guide (if available). +* Use consistent formatting throughout your code. + +**Licensing** + +Contributions to Watchman are typically licensed under the [Project License (e.g., MIT, Apache License 2.0)]. Make sure you understand the license before submitting your contribution. + +## Thank You! :love: + +We appreciate your interest in contributing to Watchman. Your contributions make the project better! From a9f951b9b2db06248430745192dcbf7ceb671f76 Mon Sep 17 00:00:00 2001 From: Tarun Manchala <50692429+Tarun-Manchala@users.noreply.github.com> Date: Thu, 28 Mar 2024 16:10:14 +0530 Subject: [PATCH 2/2] Update CONTRIBUTING_GUIDE.md --- CONTRIBUTING_GUIDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING_GUIDE.md b/CONTRIBUTING_GUIDE.md index 706f3d4e4cd9..3f570828fb85 100644 --- a/CONTRIBUTING_GUIDE.md +++ b/CONTRIBUTING_GUIDE.md @@ -39,10 +39,10 @@ Review our **[Code of Conduct](https://github.com/facebook/watchman/blob/main/CO * Please adhere to the project's coding style guide (if available). * Use consistent formatting throughout your code. -**Licensing** +## :exclamation: Licensing Contributions to Watchman are typically licensed under the [Project License (e.g., MIT, Apache License 2.0)]. Make sure you understand the license before submitting your contribution. -## Thank You! :love: +## :blue_heart: Thank You! We appreciate your interest in contributing to Watchman. Your contributions make the project better!