-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from hhhrrrttt222111/main
Create CONTRIBUTING.md
- Loading branch information
Showing
1 changed file
with
60 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,60 @@ | ||
# Contributing to NoiceGRUB | ||
|
||
Thank you for considering contributing to NoiceGRUB! We welcome contributions from the community to help make this project even better. Please take a moment to read this document to understand how you can contribute. | ||
|
||
## Table of Contents | ||
|
||
- [Getting Started](#getting-started) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [How Can I Contribute?](#how-can-i-contribute) | ||
- [Pull Requests](#pull-requests) | ||
- [Bug Reports](#bug-reports) | ||
- [Feature Requests](#feature-requests) | ||
- [License](#license) | ||
|
||
## Getting Started | ||
|
||
NoiceGRUB is a collection of linear gradient-based GRUB2 themes that can be customized. By default, NoiceGRUB comes with 4 templates and 8 presets. To get started with contributing, you'll need to: | ||
|
||
1. Fork this repository. | ||
2. Clone your forked repository to your local machine. | ||
3. Make your desired changes. | ||
4. Test your changes thoroughly. | ||
5. Submit a pull request. | ||
|
||
## Code of Conduct | ||
|
||
We want all contributors to feel safe and welcome when participating in this project. Please review and follow our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
||
## How Can I Contribute? | ||
|
||
You can contribute to NoiceGRUB in several ways: | ||
|
||
- Reporting and fixing bugs. | ||
- Requesting new features. | ||
- Improving documentation. | ||
- Adding new GRUB2 themes or presets. | ||
- Enhancing existing themes or presets. | ||
- Testing and providing feedback. | ||
|
||
## Pull Requests | ||
|
||
When submitting a pull request: | ||
|
||
1. Make sure your code adheres to the project's coding standards. | ||
2. Provide a clear and concise description of your changes. | ||
3. Reference any relevant issues or feature requests. | ||
4. Ensure your changes have been tested. | ||
5. Be prepared to discuss and revise your code based on feedback. | ||
|
||
## Bug Reports | ||
|
||
If you encounter a bug or issue, please open a new issue on the GitHub repository. Be sure to include detailed information about the problem, steps to reproduce, and your environment. | ||
|
||
## Feature Requests | ||
|
||
If you have an idea for a new feature or improvement, please open a new issue on the GitHub repository. Describe the feature or improvement you'd like to see and provide context for its usefulness. | ||
|
||
## License | ||
|
||
By contributing to NoiceGRUB, you agree that your contributions will be licensed under the project's [License](LICENSE). All contributions are subject to this license. |