You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to our project! We appreciate your interest in helping us improve it.
4
+
5
+
## How can I contribute?
6
+
7
+
There are multiple ways in which you can help us make this project even better.
8
+
9
+
- Reporting bugs or suggesting new features
10
+
- Contributing code improvements or new features
11
+
- Writing, updating, or fixing tests
12
+
- Improving documentation, including inline comments, user manuals, and developer guides
13
+
14
+
## Issue reporting
15
+
16
+
If you found a bug or have an idea for a new feature, please open an issue. Be sure to include a clear and descriptive title, as well as a detailed description of the bug or feature.
17
+
18
+
To avoid duplicate issues, please check if a similar issue has already been created.
19
+
20
+
## Making changes
21
+
22
+
To make changes to the project, please follow these steps:
23
+
24
+
1. Fork the project repository.
25
+
2. Create a new branch for your changes, based on the project's main branch.
26
+
3. Make your changes. Ensure you've followed the coding style and standards.
27
+
4. Test your changes thoroughly, ensuring all existing tests pass and new tests cover your changes where appropriate.
28
+
5. Commit your changes with a clear and descriptive commit message.
29
+
6. Push your changes to your fork.
30
+
7. Create a pull request to the project's main branch.
31
+
32
+
Once we check everything, we will merge the changes into the main branch and include it in the next release.
33
+
34
+
## Guidelines for pull requests
35
+
36
+
When submitting a pull request, please ensure that:
37
+
38
+
- Your pull request is concise and well-scoped
39
+
- Your code is properly tested
40
+
- Your code adheres to the project's coding standards and style guidelines
41
+
- Your commit message is clear and descriptive
42
+
- Your pull request includes a description of the changes you have made and why you have made them
43
+
44
+
Try to avoid creating large pull requests that include multiple unrelated changes. Instead, break them down into smaller, more focused pull requests. This will make it easier for us to review and merge your changes.
45
+
46
+
## Code of conduct
47
+
48
+
We want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [code of conduct](/CODE_OF_CONDUCT.md).
49
+
50
+
## License
51
+
52
+
By submitting a pull request you agree to release that code under the project's [license](/LICENSE).
0 commit comments