diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..12e9ff25 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to this project + +Welcome, and thank you for your interest in contributing! + +The goal of this document is to provide a high-level overview of +how you can contribute and explain how we accept contribution. + +## Reporting issues + +Please use [the repository issue tracker](https://github.com/sir-gon/algorithm-exercises-ts/issues) +to report any issues.. + +## Providing feedback or suggestions + +Similarly to bug reports, we accept improvement suggestions and feedback via +[the repository issue tracker](https://github.com/sir-gon/algorithm-exercises-ts/issues). + +## Contributing code changes + +We are thrilled that you are interested in contributing code changes! + +You can make your own fork an next, make your increment. +You only need to meet the following requirements for new contributions: + +* Any new increment MUST have a related test +with high (or preferred full) coverage. +* Use Clean Code principles. + +Once we've confirmed that we're ready to accept your contribution, +feel free to open a pull request and link it in the issue ticket. + +I will be happy to receive new contributions! + +## Code of Conduct + +Please make sure to read and follow the [Code of Conduct](./CODE_OF_CONDUCT.md).