You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-2Lines changed: 19 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,22 @@
2
2
3
3
Firstly, thank you for considering contributing to CommandKit! Whether you're looking to fix bugs, add new features, or just ask questions, your input is valuable to us.
4
4
5
+
## Consulting with maintainers before contributing
6
+
7
+
### Why consult first?
8
+
9
+
We welcome all contributions, big or small, but we also strive to keep the project focused and maintain high-quality standards. To ensure your efforts align with the project's goals and roadmap, we encourage you to consult with the maintainers before starting work on a significant contribution. This consultation can help avoid duplicated efforts, ensure that your contribution fits the project, and save time for both you and the maintainers.
10
+
11
+
### How to consult with maintainers
12
+
13
+
You can talk to a maintainer in several ways, depending on the nature of your contribution and your preference:
14
+
15
+
1. Creating an [Issue](https://github.com/underctrl-io/commandkit/issues): For proposing new features or changes, the best start is to create an issue in this GitHub repository. Please provide a clear and detailed description of what you propose, why it's needed, and how it aligns with the project's objectives. Label your issue with proposal to help us identify it quickly.
16
+
17
+
2. Starting a [Discussion](https://github.com/underctrl-io/commandkit/discussions): For more open-ended ideas or to seek feedback on a concept before it's fully fleshed out, our GitHub Discussions is the perfect place. It allows for a more informal exchange of ideas and feedback from both maintainers and other community members.
18
+
19
+
3. Contacting in the [Support Discord](https://ctrl.lol/discord): If you prefer a more direct line of communication, join our support Discord server. We have a dedicated channel for CommandKit. This is a great place to get quick feedback or clarifications before diving deep into your work.
20
+
5
21
## Setup
6
22
7
23
### Prerequisites
@@ -13,10 +29,11 @@ Firstly, thank you for considering contributing to CommandKit! Whether you're lo
13
29
### Fork & Clone
14
30
15
31
1. Fork the repository to your own GitHub account.
You are currently looking at the next major version of CommandKit. You can view the `master` branch [here](https://github.com/underctrl-io/commandkit/tree/master)
10
+
9
11
## Support and Suggestions
10
12
11
13
If you are looking for support or want to provide suggestions, check out the [Discord](https://ctrl.lol/discord).
0 commit comments