Skip to content

Commit 81c04b9

Browse files
author
Alexis Huvier
authored
Create CONTRIBUTING.md
1 parent dd94149 commit 81c04b9

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# How to contribute
2+
3+
SharpEngine is a little project and I am happy to see that people want to contribute to it. So thanks !
4+
5+
To contribute efficiently, there is some things that you can do.
6+
7+
## Reporting bugs, proposing features or improvements
8+
9+
You can simply make an issue with the template (soon).
10+
11+
## Contributing pull requests
12+
13+
If you want to add your own features / bug fixes, please make sure that :
14+
- This features is usable in real projets.
15+
- You talked with other developer if somebody work on that already.
16+
- Your work follows code style and git guidelines
17+
18+
If you want to add a feature / bug fixes, you can find some in issues of this projects.
19+
20+
### Git Guidelines
21+
22+
- Try to make simple PRs (or issues) which target one specific topic.
23+
- Try to keep a clean git history.
24+
- Try to keep relevent and short branches names. Use dashes to separate words.
25+
- Try you work before pushing.
26+
27+
### Code Style Guidelines
28+
29+
- Use CSharpier to format your work. It's already installed in every SharpEngine's Project.

0 commit comments

Comments
 (0)