Create CONTRIBUTING.md (#418) (#424)

Co-authored-by: tkernell <[email protected]> (cherry picked from commit 680680f) Co-authored-by: themandalore <[email protected]> Co-authored-by: tkernell <[email protected]>
tellor-io · Nov 4, 2024 · b85f282 · b85f282
1 parent 80731ff
commit b85f282
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,29 @@
+# Contributing to Tellor
+
+We want to make contributing to this project as easy and transparent as possible.
+
+## Pull Requests
+
+We actively welcome your pull requests.
+
+If you're new, we encourage you to take a look a the issues or open draft PR's before starting.  
+
+### For new contributions or bug fixes
+
+0. Create a GitHub issue proposing your fix if not already existing
+1. Fork the repo and create your branch from `main`.
+3. Make your code change.
+4. Make sure that all tests run (instructions on running the tests can be found in the README.md
+5. Make the PR
+7. Address any feedback in code review promptly
+
+
+## Issues
+
+We use GitHub issues to track public bugs. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+## License
+
+By contributing to examples, you agree that your contributions will be licensed
+under the LICENSE file in the root directory of this source tree.