Skip to content

Commit 3172344

Browse files
Add contributing guidelines
1 parent c7895c6 commit 3172344

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing to Unity Custom Inspector Creator
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+
## All Code Changes Happen Through Pull Requests
14+
Pull requests are the best way to propose changes to the codebase. 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 test suite passes.
20+
5. Make sure your code lints.
21+
6. Issue that pull request!
22+
23+
## Any contributions you make will be under the MIT Software License
24+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
25+
26+
## Report bugs using Github's [issues](https://github.com/GlassToeStudio/UnityCustomInspectorCreator/issues)
27+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/GlassToeStudio/UnityCustomInspectorCreator/issues/new); it's that easy!
28+
29+
## Write bug reports with detail, background, and sample code
30+
31+
**Great Bug Reports** tend to have:
32+
33+
- A quick summary and/or background
34+
- Steps to reproduce
35+
- Be specific!
36+
- Give sample code if you can.
37+
- What you expected would happen
38+
- What actually happens
39+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
40+
41+
### Example:
42+
**Steps To Reproduce**
43+
* Start app
44+
* Populate 'add' box(es) with 4 and 5
45+
* Click 'Add' Button
46+
47+
**Expected Behavior**
48+
* Output should be 9
49+
50+
**Actual Behavior**
51+
* Output is -1
52+
53+
**If error: provide line number and/or stack trace**
54+
* Error on line 56 of MathUtils.cs
55+
56+
```cs
57+
>54 public int Add(int a, int b)
58+
>55 {
59+
>56 return(a - b);
60+
>57 }
61+
```
62+
63+
64+
People *love* thorough bug reports. I'm not even kidding.
65+
66+
## Use a Consistent Coding Style
67+
We use [Microsoft's .NET Guidelines](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/)
68+
69+
* 4 spaces for indentation rather than tabs
70+
* We use Visual Studio or VS Code, which should allow you to automagically implement some of these.
71+
72+
## License
73+
By contributing, you agree that your contributions will be licensed under its [MIT License](LISCENSE).
74+
75+
## References
76+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) and this this one [By briandk](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)

0 commit comments

Comments
 (0)