Skip to content

Commit 2e761e6

Browse files
committed
chore(docs): add How to contribute
Signed-off-by: Grigorii K. Shartsev <[email protected]>
1 parent 683de8b commit 2e761e6

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,27 @@ import { NcButton, useHotKey } from '@nextcloud/vue'
5050

5151
## 🤝 Contributing
5252

53+
### 📜 How to contribute
54+
55+
1. It's always good to check/create an issue first and discuss the problem or feature you want to work on
56+
2. Fork the repository and create a new branch
57+
3. Make the changes
58+
4. Check the change in Vue-Styleguidist and/or Nextcloud apps
59+
- Do not forget to `lint` and `test` your changes
60+
- If possible, add tests for your changes
61+
5. Commit and push your changes, create a Pull Request
62+
- Make sure to follow the [Conventional Commits](https://www.conventionalcommits.org) in commit messages, and PR titles, for example:\
63+
`fix(NcButton): correct layout on Safari`
64+
- Make sure to follow the **Pull Request template**
65+
- Sign-off you commits for the [Developer Certificate of Origin (DCO)](https://developercertificate.org/)
66+
6. Get your PR reviewed
67+
- If you don't receive a feedback in a week, feel free to mention the maintainers, for example, last developers worked on the module
68+
7. Get your PR merged
69+
70+
Please read the [Code of Conduct](https://nextcloud.com/community/code-of-conduct/). This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere and to explain how together we can strengthen and support each other.
71+
72+
More information on how to contribute: [https://nextcloud.com/contribute/](https://nextcloud.com/contribute/)
73+
5374
### 🧑‍💻 Development setup
5475

5576
If you want to work on improving the components it’s best to run the latest code and link it to your local Nextcloud installation:

0 commit comments

Comments
 (0)