Skip to content

Commit 3eadb2d

Browse files
authored
Add contributing.md document (#15)
Add Contributing.md document
1 parent 151426e commit 3eadb2d

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+
# Cloud-Pine is an OPEN Open Source Project
2+
3+
Thank you for taking an interest in contributing to Cloud-Pine! No
4+
contribution is too small :)
5+
This guide is an attempt to standardize the flow and to help you make a contribution.
6+
7+
## Where do I start?
8+
9+
1. **Code improvements**: Take a look at our Issues tab, especially the [help wanted](https://github.com/metcoder95/cloud-pine/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) label
10+
2. **Documentation improvements**: Go through our documentation and search for small typo corrections to major document reworks
11+
3. **Open issue**: Report an error you can’t solve yourself, discuss a high-level topic or idea, propose a new feature or other project idea 🙌
12+
13+
## Ground Rules
14+
15+
1. If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
16+
2. Please be respectful, kind and thoughtful. Behind the screen are human beings with their own beautiful history.
17+
18+
## How to contribute?
19+
20+
1. Fork the cloud-pine repository. More detailed information can be found [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
21+
2. Open and [configure](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork) your newly forked repository
22+
3. Create a new branch in the forked repository
23+
4. Make some changes ✨✨✨
24+
5. Commit your changes with a meaningful description
25+
6. Push out your changes
26+
7. Create a pull request!
27+
8. ... and wait for review :)
28+
29+
... see you in the PR!

0 commit comments

Comments
 (0)