Skip to content

Commit 53335fe

Browse files
torgogarethr
authored andcommitted
Create CONTRIBUTING.md
1 parent 49cb0c8 commit 53335fe

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# CONTRIBUTING.md
2+
3+
First and foremost, thank you for considering contributing to Parlay! Your contribution is valuable and we genuinely appreciate your interest.
4+
5+
Parlay is a distinct software project developed by Snyk. Although separate from our core product line, it provides a platform for us to demonstrate our capabilities and some key concepts.
6+
7+
Please note that we monitor and respond to issues and pull requests on a best-effort basis.
8+
9+
### How to contribute
10+
11+
#### Code of Conduct
12+
13+
Prior to contributing, please familiarize yourself with our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all our contributors to uphold these guidelines to maintain a respectful and inclusive environment.
14+
15+
#### Open Development
16+
17+
All development work on Parlay is done directly on GitHub. Both our core team members and external contributors send pull requests, which go through a unified review process.
18+
19+
#### Reporting Issues
20+
21+
We welcome you to raise an issue if you discover a bug, find a documentation error, or identify a feature you believe should be added. You can do this by opening a new issue in the issue tracker. Please ensure that your issue hasn't already been reported by reviewing existing issues before creating a new one. We value the time and effort you spend in providing these details.
22+
23+
#### Pull Requests
24+
25+
We highly recommend that contributors raise an issue before making a pull request. This allows us to discuss potential changes and prevent unnecessary or duplicative work. Once the issue has been reviewed and we've agreed on a solution, contributors can then fork the repository and submit a pull request.
26+
27+
##### Submitting your Pull Request
28+
29+
- Ensure your code passes all tests, and consider adding new tests for the changes you've made.
30+
- In your Pull Request description, provide a detailed explanation of your changes. This assists us in understanding your decision-making process and aids in the effective review of your work.
31+
- Remember to reference the relevant issue number in your pull request.
32+
33+
Your time and efforts make Parlay better, and we're grateful for your support and contributions. Thank you!

0 commit comments

Comments
 (0)