Skip to content

Commit 2d3c989

Browse files
committed
Updated contributing
1 parent de712f9 commit 2d3c989

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

CONTRIBUTING.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to FreeRGB
2+
3+
First and foremost, thanks for taking the the time to contribute. :raised_hands:
4+
5+
The following document is just a set of guidelines for contributing to the project.
6+
These are mostly guidelines, not necessarily rules.
7+
Please feel free to propose any changes to these guidelines in a pull request.
8+
9+
Whether you're reporting a bug, submitting a fix, proposing new features, or just providing feedback, we want to make contributing to this project as easy as possible.
10+
11+
## Code of Conduct
12+
13+
This project and everyone participating in it is goverened by the [code of conduct](CODE_OF_CONDUCT.md).
14+
By participating, you are expected to uphold this code.
15+
Please make sure to read it prior to contributing.
16+
17+
## Documentation
18+
19+
We use a [GitHub wiki](https://github.com/milan338/FreeRGB/wiki) for documentation.
20+
You can find information on using and developing for this project here.
21+
22+
## We Develop with GitHub
23+
24+
We use GitHub to host code, track issues and feature requests, and accept pull requests.
25+
26+
## We Use [GitHub Flow](https://guides.github.com/introduction/flow/index.html)
27+
28+
Pull requests are the best way to propose codebase changes.
29+
We actively welcome your pull requests:
30+
1. Fork the repo and create your branch from `master`
31+
2. If you've added code that should be tested, add tests and ensure they pass
32+
3. If you've changed APIs, update the documentation
33+
4. Make sure your code follows the style guidelines
34+
5. Submit your pull request
35+
36+
## Contributions Made Will be Under the [Project License](LICENSE)
37+
38+
Whenever you submit code changes, these submissions will be under the same [license](LICENSE) that covers the project.
39+
Please feel free to contact the maintainers if that's a concern.
40+
41+
## Report Bugs and Feature Requests using GitHub's Issue Tracker
42+
43+
We use GitHub issues to track bugs.
44+
Report a bug by opening a new issue.
45+
Remember to select the right template for your issue and to follow it.
46+
47+
## Follow a Consistent Coding Style
48+
49+
This project adheres to [PEP 8](https://www.python.org/dev/peps/pep-0008/) rules where it does not impact readability.
50+
51+
Some general guidelines:
52+
- `snake_case` for variable and module names
53+
- `camelCase` for function and method names
54+
- `PascalCase` for class and object names
55+
- Try to adhere to a 79 character character line limit
56+
57+
Where readability can be improved, however, exceptions can of course be made.
58+
For example, module names for effects should use `PascalCase` rather than `snake_case` to keep the same name as its main class.

0 commit comments

Comments
 (0)