-
-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Contributing to KFtray | ||
|
||
👋 Thanks for your interest in contributing to KFtray! We're glad you want to help out and we look forward to your involvement in our community. Here are some guidelines to help you get started. | ||
|
||
## How to Contribute | ||
|
||
### Reporting Bugs or Issues | ||
|
||
- Check the [Issues](https://github.com/hcavarsan/kftray/issues) page to make sure it hasn't already been reported. | ||
- Click on the 'New Issue' button and choose the appropriate template. | ||
- Fill out all necessary fields with as much information as possible. | ||
- The more information you can provide, the more likely we'll be able to help. | ||
|
||
### Suggesting Enhancements | ||
|
||
- Look through the [Issues](https://github.com/hcavarsan/kftray/issues) to ensure your suggestion doesn't already exist. | ||
- Create a new issue, select the feature request template, and detail your idea. | ||
|
||
### Pull Requests | ||
|
||
- Fork the repository and create your branch from `main`. | ||
- If you've added code that should be tested, add some tests. | ||
- Ensure your code lints (e.g., using `pnpm run lint`). | ||
- Write clear, descriptive commit messages. | ||
- Open a new pull request with a clear title and description. | ||
|
||
### Setting Up Your Environment | ||
|
||
Before you can start contributing to KFtray, you'll need to set up your development environment. Please follow the [Installation](https://github.com/hcavarsan/kftray#-installation) instructions in the README. | ||
|
||
## Code of Conduct | ||
|
||
Participation in the KFtray community is governed by a [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before contributing to make sure you understand our community standards. | ||
|
||
## Asking Questions | ||
|
||
We welcome any developer to ask questions and get help from our community. Just make an issue with the tag 'question' and we'll get back to you as soon as we can. | ||
|
||
Once again, thanks for your interest in KFtray. We're excited to see what you bring to our community! | ||
|
||
KFtray is distributed under the [MIT License](LICENSE.md). |