Skip to content

Commit

Permalink
update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
notunderctrl committed Feb 4, 2024
1 parent 679ddf4 commit 78327b9
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

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.

## Consulting with maintainers before contributing

### Why consult first?

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.

### How to consult with maintainers

You can talk to a maintainer in several ways, depending on the nature of your contribution and your preference:

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.

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.

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.

## Setup

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

1. Fork the repository to your own GitHub account.

2. Clone your fork to your local machine:

```bash
git clone https://github.com/underctrl-io/commandkit.git
git clone https://github.com/your-username/commandkit.git
```

### Installing Dependencies
Expand Down Expand Up @@ -57,7 +74,7 @@ git commit -m "Describe your change here"
git push origin your-feature-or-bugfix
```

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

## Submitting Issues

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
<a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/dt/commandkit?maxAge=3600" alt="npm downloads" /></a>
</div>

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)

## Support and Suggestions

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

0 comments on commit 78327b9

Please sign in to comment.