Skip to content

Commit a5a4f1a

Browse files
Revise CONTRIBUTING.md for improved clarity
Updated contributing guidelines for clarity and consistency. Signed-off-by: CreativeCodeCat <[email protected]>
1 parent 795b675 commit a5a4f1a

File tree

1 file changed

+47
-62
lines changed

1 file changed

+47
-62
lines changed

CONTRIBUTING.md

Lines changed: 47 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,80 @@
11
# Contributing to mLauncher
2-
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
32

4-
- Reporting a bug
5-
- Discussing the current state of the code
6-
- Submitting a fix
7-
- Proposing new features
8-
- Becoming a maintainer
3+
We love your input! Contributing to this project can include:
94

10-
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
5+
- Reporting a bug
6+
- Discussing the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
1110

12-
## Quicklinks
11+
Following these guidelines helps make the contribution process smooth for everyone and ensures that all contributors’ time is respected. In return, we will review issues, assess changes, and help finalize pull requests efficiently.
1312

14-
* [Code of Conduct](#code-of-conduct)
15-
* [Getting Started](#getting-started)
16-
* [We Develop with Github](#we-develop-with-github)
17-
* [Pull Requests](#pull-requests)
18-
* [Issues](#issues)
19-
* [Code Style](#code-style)
20-
* [License](#license)
13+
## Quick Links
14+
15+
* [Code of Conduct](#code-of-conduct)
16+
* [Getting Started](#getting-started)
17+
* [Using GitHub](#using-github)
18+
* [Pull Requests](#pull-requests)
19+
* [Issues](#issues)
20+
* [Code Style](#code-style)
21+
* [License](#license)
2122

2223
## Code of Conduct
2324

24-
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](CODE-OF-CONDUCT.md).
25+
By participating in this project, you agree to uphold our [Code of Conduct](CODE-OF-CONDUCT.md). We expect all contributors to communicate respectfully and maintain a positive, inclusive environment.
2526

2627
## Getting Started
2728

28-
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
29+
All contributions are made via **Issues** and **Pull Requests (PRs)**.
2930

30-
- Search for existing Issues and PRs before creating your own.
31-
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
31+
- **Check existing issues and PRs** before submitting new ones.
32+
- Friendly comments or pings can help maintainers notice important or blocking issues.
3233

34+
### Using GitHub
3335

34-
### We Develop with Github
35-
We use github to host code, to track issues and feature requests, as well as accept pull requests.
36+
We use GitHub to host code, track issues, and accept PRs.
3637

3738
### Pull Requests
3839

39-
**We Use ["fork-and-pull" Git workflow](FAPRW.md), So All Code Changes Happen Through Pull Requests**
40-
41-
Pull requests are the best way to propose changes to the codebase (In general, we follow the ["fork-and-pull" Git workflow](FAPRW.md)). We actively welcome your pull requests:
40+
We follow a **fork-and-pull Git workflow**:
4241

43-
1. Fork the repository to your own Github account
44-
2. Clone the project to your machine
45-
3. Create a branch locally with a succinct but descriptive name
46-
4. Commit changes to the branch
47-
5. Following any formatting and testing guidelines specific to this repo
48-
6. Push changes to your fork
49-
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
42+
1. Fork the repository to your GitHub account.
43+
2. Clone your fork locally.
44+
3. Create a descriptive branch.
45+
4. Commit your changes following formatting and testing guidelines.
46+
5. Push changes to your fork.
47+
6. Open a PR using the template.
5048

51-
In general, PRs should:
49+
**Best practices for PRs:**
5250

53-
- Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
54-
- Address a single concern in the least number of changed lines as possible.
55-
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
51+
- Address one concern per PR.
52+
- Focus on a single functionality or widespread style fixes, not both.
53+
- Keep changes minimal for easier review.
54+
- Use the PR template for clarity.
5655

57-
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
56+
For major changes or breaking updates, open an issue first to discuss your proposal.
5857

5958
### Issues
6059

61-
Issues should be used to report problems with the project, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
62-
63-
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.
64-
65-
**Report bugs using Github's [issues](https://github.com/DroidWorksStudio/mLauncher/issues)**
66-
67-
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/DroidWorksStudio/mLauncher/issues/new/choose); it's that easy!
60+
Use issues to report bugs, request features, or discuss potential changes.
6861

69-
Write bug reports with detail, background, and sample code
62+
- **Check for existing issues** and add your input rather than opening duplicates.
63+
- Use [reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to signal impact.
64+
- **Report bugs with detail**:
7065

71-
**Great Bug Reports** tend to have:
72-
73-
- A quick summary and/or background
74-
- Steps to reproduce
75-
- Be specific!
76-
- Give sample code if you can.
77-
- What you expected would happen
78-
- What actually happens
79-
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
80-
81-
People *love* thorough bug reports. I'm not even kidding.
66+
- Summary or background
67+
- Steps to reproduce (include code if possible)
68+
- Expected vs. actual behavior
69+
- Notes on potential causes or prior attempts
8270

8371
### Code Style
8472

85-
**Use a Consistent Coding Style**
86-
87-
* 4 spaces for indentation rather than tabs
73+
- Use **4 spaces** for indentation (no tabs).
74+
- Maintain consistent formatting throughout your code.
8875

8976
## License
9077

91-
**Any contributions you make will be under the GPL-3.0 License**
92-
93-
In short, when you submit code changes, your submissions are understood to be under the same [GPL-3.0 License]([http://choosealicense.com/licenses/mit/](https://choosealicense.com/licenses/gpl-3.0/)) that covers the project. Feel free to contact the maintainers if that's a concern.
78+
All contributions are under the **GPL-3.0 License**. By submitting changes, you agree that your contributions will be licensed under the same terms as this project.
9479

95-
By contributing, you agree that your contributions will be licensed under its GPL-3.0 License.
80+
[GPL-3.0 License Details](http://choosealicense.com/licenses/gpl-3.0/)

0 commit comments

Comments
 (0)