Skip to content

Commit 6f7e839

Browse files
authoredMay 3, 2022
Create CONTRIBUTING.md
add contributing info
1 parent 8e3f365 commit 6f7e839

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed
 

‎CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to GdUnit3
2+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
4+
- Reporting a bug
5+
- Discussing the current state of the code
6+
- Submitting a fix
7+
- Proposing new features
8+
- Becoming a maintainer
9+
10+
## We Develop with Github
11+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
12+
13+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
14+
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
15+
16+
1. Fork the repo and create your branch from `master`.
17+
2. If you've added code that should be tested, add tests.
18+
3. If you've changed APIs, update the documentation.
19+
4. Ensure the CI passes.
20+
5. Issue that pull request!
21+
22+
## Any contributions you make will be under the MIT Software License
23+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
24+
25+
## Report bugs using Github's
26+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/MikeSchulze/gdUnit3/issues/new?assignees=MikeSchulze&labels=bug%2C+task&template=bug_report.md&title=); it's that easy!
27+
28+
Write bug reports with detail, background, and sample code
29+
30+
## Use a Consistent Coding Style
31+
I'm again borrowing these from
32+
- [Godot's GDScript Conventions](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html)
33+
- [C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions)
34+
35+
## License
36+
By contributing, you agree that your contributions will be licensed under its [MIT License](https://github.com/MikeSchulze/gdUnit3/blob/master/LICENSE).
37+
38+
## References
39+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

0 commit comments

Comments
 (0)
Please sign in to comment.