Skip to content

Commit

Permalink
[DOCS] added contribution (#84)
Browse files Browse the repository at this point in the history
* doc: added contribution
  • Loading branch information
a-chumagin authored May 30, 2023
1 parent 7fc3800 commit 6a1ddb5
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing to Data-Quality-Gate

Thank you for your interest in contributing to Data-Quality-Gate! This document outlines the process and guidelines for contributing to our project.

## Code of Conduct

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.

## Reporting Issues

- Search for existing issues before reporting a new one.
- Provide a clear and concise description of the issue.
- Include steps to reproduce the issue and any relevant error messages or logs.
- If possible, provide a minimal, reproducible example.

## Submitting Pull Requests

- Fork the repository and create a new branch for your changes.
- Ensure that your branch is up-to-date with the latest version of the main branch.
- Follow the project's coding style and conventions.
- Add a meaningful title and description for your pull request (PR)
- [BUGFIX] for PRs that address minor bugs without changing behavior.
- [FEATURE] for significant PRs that add a new feature likely to require being added to our feature maturity matrix.
- [MAINTENANCE] for PRs that focus on updating repository settings or related changes.
- [DOCS] for PRs that focus on updating or adding documentation.
- Write clear and concise commit messages.
- Include tests to ensure that your changes do not introduce regressions.
- Provide a description of the changes you made in the pull request description.
- Address any feedback or requested changes from the maintainers.

## Testing

- Write tests for your changes, ensuring that they cover edge cases and potential issues.
- Use the provided testing framework or create a new one if necessary.
- Ensure that your tests are comprehensive and cover both positive and negative scenarios.

## Documentation

- Update the README and other documentation to reflect changes in the project.
- Ensure that the documentation is clear, concise, and accurate.
- Include examples and usage instructions to help users understand how to use the project.


## Contact Us

- If you have any questions or need assistance, feel free to open an issue or reach out to the maintainers on GitHub.
- We welcome any suggestions for improvements or new features.

We look forward to working with you and improving Data-Quality-Gate together!

0 comments on commit 6a1ddb5

Please sign in to comment.