Skip to content

Commit c5f64f9

Browse files
authored
Merge pull request #2 from hhhrrrttt222111/main
Create CONTRIBUTING.md
2 parents 972dfb2 + 8eaf94f commit c5f64f9

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

CONTRIBUTING.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing to NoiceGRUB
2+
3+
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.
4+
5+
## Table of Contents
6+
7+
- [Getting Started](#getting-started)
8+
- [Code of Conduct](#code-of-conduct)
9+
- [How Can I Contribute?](#how-can-i-contribute)
10+
- [Pull Requests](#pull-requests)
11+
- [Bug Reports](#bug-reports)
12+
- [Feature Requests](#feature-requests)
13+
- [License](#license)
14+
15+
## Getting Started
16+
17+
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:
18+
19+
1. Fork this repository.
20+
2. Clone your forked repository to your local machine.
21+
3. Make your desired changes.
22+
4. Test your changes thoroughly.
23+
5. Submit a pull request.
24+
25+
## Code of Conduct
26+
27+
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).
28+
29+
## How Can I Contribute?
30+
31+
You can contribute to NoiceGRUB in several ways:
32+
33+
- Reporting and fixing bugs.
34+
- Requesting new features.
35+
- Improving documentation.
36+
- Adding new GRUB2 themes or presets.
37+
- Enhancing existing themes or presets.
38+
- Testing and providing feedback.
39+
40+
## Pull Requests
41+
42+
When submitting a pull request:
43+
44+
1. Make sure your code adheres to the project's coding standards.
45+
2. Provide a clear and concise description of your changes.
46+
3. Reference any relevant issues or feature requests.
47+
4. Ensure your changes have been tested.
48+
5. Be prepared to discuss and revise your code based on feedback.
49+
50+
## Bug Reports
51+
52+
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.
53+
54+
## Feature Requests
55+
56+
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.
57+
58+
## License
59+
60+
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.

0 commit comments

Comments
 (0)