Skip to content

Commit d9063df

Browse files
authored
Update CONTRIBUTING.md
1 parent 6946f72 commit d9063df

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
11

2+
## How to contribute to RubyMutant
3+
---
4+
5+
Did you find a bug?
6+
- Ensure the bug was not already reported by searching on Github under [issues](https://github.com/coreyjs/ruby-mutant/issues).
7+
- If you are unable to find any issue that is the same or address your problem, feel free to open a new bug report issue. A clear and concise title and description of the bug and as much information possible on reproducible steps would greatly ensure the squashing of said bug.
8+
9+
10+
**Did you create a patch that fixes a bug?**
11+
- Open a new PR with the code fix
12+
- Ensure your PR description is clear and concise and describes the problem and the solution. Include the issue # as well.
13+
- Make sure your patch has the appropriate test coverage to confirm the fix.
14+
- Once in review, a maintainer will review the PR and provide any needed feedback and guidance to help get the PR merged in.
15+
16+
17+
**Did you want to add a new feature or enhancement?**
18+
- Create a feature request using the "Feature Request" issue template, [here](https://github.com/coreyjs/ruby-mutant/issues/new?assignees=&labels=&template=feature_request.md&title=)
19+
- Be clear about the feature you want to add, the problem it is looking to solve or the idea/intent behind the feature.
20+
- If you plan to build the feature yourself, tag the issue with the label `work in progress` and assign yourself as an `Assignee` (or a maintainer can if permissions dont allow).
21+
- For branch naming conventions when dealing with features, please prefix the branch name with`feature/` such as `feature/this-adds-async-support`
22+
- Once ready for review, open a PR with the base branch being `master`. Once all builds are complete and passing, a maintainer will your with you to finalize any code changes that may be necessary.
23+
24+
25+
Thanks everyone for their interest in this project! This is meant to be a learning expiernce for everyone, to learn how to contribute and work in open source. I encourage you to pitch in and let your creativity drive you. ❤️❤️❤️

0 commit comments

Comments
 (0)