diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c7d27d2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing Guidelines + +Thanks you so much for your interest in contributing to this project! + +## About our deal + +I'm Mateus and I'm the creator and maintainer of this project. + +If you encounter bugs, please **do** open an issue describing the bug and including steps to easily reproduce it (bonus points for a CodeSandbox that demonstrates the problem). + +If you have an idea for an enhancement, go ahead and share it via an issue, but please don't expect a timely response. + +## Bug reports + +If you encounter a problem with this project, please open an issue. Be sure to include: + +- Node and React versions +- Brief but thorough description of the issue +- Link to a CodeSandbox (or similar) demonstrating the problem (optional, but highly recommended, especially for complex problems) diff --git a/README.md b/README.md index 4176e7d..17e89bc 100644 --- a/README.md +++ b/README.md @@ -64,15 +64,15 @@ To deploy this project run: yarn build ``` -## Contributing +## Feedback -If you liked the project and want to cooperate feel free to fork this repository and send Pull Requests. +If you have any ideas or feedback for this project, please let me know. Connect with me on [Twitter](https://twitter.com/fariasmateuss) or [LinkedIn](https://www.linkedin.com/in/fariasmateuss/). -All kinds of contributions are very welcome and appreciated. +## Contributing -## Contact me +If you found this useful, please help us improve it by contributing. -Connect with me at [LinkedIn](https://www.linkedin.com/in/fariasmateuss/) +See [contributing](/docs/CONTRIBUTING.md) for more details. # License