Skip to content

Commit 2bf6e81

Browse files
authored
Create CONTRIBUTING.md
1 parent 87b73c7 commit 2bf6e81

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to AutoNotify
2+
3+
Welcome, and thank you for considering contributing to **AutoNotify**! We appreciate your time and effort in improving this project. By contributing, you agree to abide by our [Code of Conduct](#code-of-conduct).
4+
5+
## How to Contribute
6+
7+
### Reporting Issues
8+
1. Check if the issue has already been reported in the [Issues](https://github.com/nakultt/AutoNotify/issues) tab.
9+
2. If not, create a new issue with:
10+
- A clear and descriptive title.
11+
- Steps to reproduce the problem (if applicable).
12+
- Any relevant screenshots or logs.
13+
14+
### Suggesting Enhancements
15+
1. Open a new issue in the [Issues](https://github.com/nakultt/AutoNotify/issues) tab, providing:
16+
- A detailed explanation of your suggestion.
17+
- The benefits it would bring to the project.
18+
19+
### Pull Requests
20+
1. Fork the repository and create a new branch:
21+
- Use a descriptive branch name (e.g., `feature-new-action` or `bugfix-input-error`).
22+
2. Make your changes:
23+
- Write clean, readable code following Python best practices.
24+
- Ensure your changes are covered by tests.
25+
3. Test your changes locally.
26+
4. Submit a pull request:
27+
- Provide a detailed description of the changes made.
28+
- Reference the issue(s) your PR addresses, if applicable.
29+
30+
### Coding Standards
31+
- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) for Python code style.
32+
- Write meaningful commit messages (e.g., `Fix input data validation`).
33+
- Avoid committing large, unrelated changes in a single pull request.
34+
35+
### Code of Conduct
36+
Please note that this project is governed by a [Code of Conduct](https://github.com/nakultt/AutoNotify/blob/main/CODE_OF_CONDUCT.md). By participating, you agree to uphold its standards of inclusivity and respect.
37+
38+
## Questions or Assistance
39+
If you have any questions or need help, feel free to reach out by opening a discussion in the [Discussions](https://github.com/nakultt/AutoNotify/discussions) tab.

0 commit comments

Comments
 (0)