Skip to content

Commit 5a03f47

Browse files
Create CONTRIBUTING.md
1 parent 2ed3108 commit 5a03f47

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Introduction
2+
3+
## Would you like to contribute to this project? 👀
4+
5+
First off, thank you for considering contributing. It's people like you that make it such a great tool!
6+
7+
But first, it's important that you read and follow the project's code of conduct and license. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
8+
9+
### What kind of contributions are we looking for?
10+
11+
Fortunately, there are many ways to contribute! From writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the project itself.
12+
13+
Then, again, you can contribute on pretty much all you want as long as it doesn't violate our code of conduct or license.
14+
15+
## Responsibilities
16+
17+
When contributing, keep in mind the following responsibilities:
18+
19+
* Ensure cross-platform compatibility for every change: Windows, MacOS, and diverse Linux distros.
20+
* Ensure that code that goes into core comply with readability and maintainability principles.
21+
* Ensure that every change you make to the source code pass all CI tests.
22+
* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
23+
* Keep feature versions as small as possible, preferably one new feature per version.
24+
* Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
25+
26+
## How to submit a contribution.
27+
28+
You can submit pull requests to the project's GitHub repository. Similarly, you may also explain issues or answer questions on their corresponding GitHub sections.
29+
30+
## Community
31+
32+
You can use this project's GitHub discussions section to chat with core developers or other members or the project's community.
33+

0 commit comments

Comments
 (0)