Skip to content

Commit 6a1ddb5

Browse files
authored
[DOCS] added contribution (#84)
* doc: added contribution
1 parent 7fc3800 commit 6a1ddb5

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to Data-Quality-Gate
2+
3+
Thank you for your interest in contributing to Data-Quality-Gate! This document outlines the process and guidelines for contributing to our project.
4+
5+
## Code of Conduct
6+
7+
By participating in this project, you agree to abide by our [Code of Conduct](https://github.com/provectus/data-quality-gate/blob/main/CODE_OF_CONDUCT.md). Please read it before contributing.
8+
9+
## Reporting Issues
10+
11+
- Search for existing issues before reporting a new one.
12+
- Provide a clear and concise description of the issue.
13+
- Include steps to reproduce the issue and any relevant error messages or logs.
14+
- If possible, provide a minimal, reproducible example.
15+
16+
## Submitting Pull Requests
17+
18+
- Fork the repository and create a new branch for your changes.
19+
- Ensure that your branch is up-to-date with the latest version of the main branch.
20+
- Follow the project's coding style and conventions.
21+
- Add a meaningful title and description for your pull request (PR)
22+
- [BUGFIX] for PRs that address minor bugs without changing behavior.
23+
- [FEATURE] for significant PRs that add a new feature likely to require being added to our feature maturity matrix.
24+
- [MAINTENANCE] for PRs that focus on updating repository settings or related changes.
25+
- [DOCS] for PRs that focus on updating or adding documentation.
26+
- Write clear and concise commit messages.
27+
- Include tests to ensure that your changes do not introduce regressions.
28+
- Provide a description of the changes you made in the pull request description.
29+
- Address any feedback or requested changes from the maintainers.
30+
31+
## Testing
32+
33+
- Write tests for your changes, ensuring that they cover edge cases and potential issues.
34+
- Use the provided testing framework or create a new one if necessary.
35+
- Ensure that your tests are comprehensive and cover both positive and negative scenarios.
36+
37+
## Documentation
38+
39+
- Update the README and other documentation to reflect changes in the project.
40+
- Ensure that the documentation is clear, concise, and accurate.
41+
- Include examples and usage instructions to help users understand how to use the project.
42+
43+
44+
## Contact Us
45+
46+
- If you have any questions or need assistance, feel free to open an issue or reach out to the maintainers on GitHub.
47+
- We welcome any suggestions for improvements or new features.
48+
49+
We look forward to working with you and improving Data-Quality-Gate together!

0 commit comments

Comments
 (0)