Skip to content

Commit 78327b9

Browse files
committed
update contributing guide
1 parent 679ddf4 commit 78327b9

2 files changed

Lines changed: 21 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
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.
44

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+
521
## Setup
622

723
### Prerequisites
@@ -13,10 +29,11 @@ Firstly, thank you for considering contributing to CommandKit! Whether you're lo
1329
### Fork & Clone
1430

1531
1. Fork the repository to your own GitHub account.
32+
1633
2. Clone your fork to your local machine:
1734

1835
```bash
19-
git clone https://github.com/underctrl-io/commandkit.git
36+
git clone https://github.com/your-username/commandkit.git
2037
```
2138

2239
### Installing Dependencies
@@ -57,7 +74,7 @@ git commit -m "Describe your change here"
5774
git push origin your-feature-or-bugfix
5875
```
5976

60-
7. Open a pull request in the main project repository (master branch). Describe your changes and any relevant information.
77+
7. Open a pull request in the main project repository (`master` branch). Describe your changes and any relevant information.
6178

6279
## Submitting Issues
6380

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/dt/commandkit?maxAge=3600" alt="npm downloads" /></a>
77
</div>
88

9+
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+
911
## Support and Suggestions
1012

1113
If you are looking for support or want to provide suggestions, check out the [Discord](https://ctrl.lol/discord).

0 commit comments

Comments
 (0)