Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Contributing Guidelines #1204

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adding Contributing Guidelines #1204

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e70f933
added Contributing guidelines
Tarun-Manchala Mar 28, 2024
a9f951b
Update CONTRIBUTING_GUIDE.md
Tarun-Manchala Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions CONTRIBUTING_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

## :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.

## :blue_heart: Thank You!

We appreciate your interest in contributing to Watchman. Your contributions make the project better!