Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nandika-A authored May 10, 2024
1 parent e6fcd0c commit 18d10a7
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing to EyeProtection

Thank you for considering contributing to EyeProtection! We welcome contributions from the community to help improve this project. By contributing, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md).

## Ways to Contribute

There are several ways to contribute to EyeProtection:

- **Reporting Issues**: If you encounter a bug or have a feature request, please [open an issue](https://github.com/Nandika-A/EyeProtection/issues/new) to let us know.

- **Feature Development**: If you'd like to work on a new feature, feel free to open a discussion in an issue or directly submit a pull request.

- **Bug Fixes**: Help us squash bugs! Check out the open issues, particularly those labeled "help wanted", to find a bug to fix.

## How to Contribute

1. **Fork the repository** and clone it locally.

2. **Create a new branch** for your feature or bug fix:
```bash
git checkout -b my-feature-branch
```

3. **Make your changes** and test thoroughly.

4. **Commit your changes**:
```bash
git commit -am 'Add new feature or Fix issue'
```

5. **Push your branch** to your fork:
```bash
git push origin my-feature-branch
```

6. **Submit a Pull Request**:
- Go to the [EyeProtection repository](https://github.com/Nandika-A/EyeProtection).
- Click on "Compare & pull request" for your branch.
- Fill in the PR template with details of your contribution.


## Code of Conduct

Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) when participating in this project.

## License

By contributing to EyeProtection, you agree that your contributions will be licensed under the [MIT License](LICENSE).

0 comments on commit 18d10a7

Please sign in to comment.