Skip to content

Commit ffc99bb

Browse files
committed
Updated docs
1 parent 0e2a7e5 commit ffc99bb

File tree

3 files changed

+28
-52
lines changed

3 files changed

+28
-52
lines changed

.github/FUNDING.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
github: ionicabizau
22
patreon: ionicabizau
33
open_collective: ionicabizau
4+
custom: https://www.buymeacoffee.com/h96wwchmy

CONTRIBUTING.md

+25-50
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,41 @@
1-
# :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles: :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk:
1+
# Contributing :star: :star2: :dizzy:
22

3-
So, you want to contribute to this project! That's awesome. However, before
4-
doing so, please read the following simple steps how to contribute. This will
5-
make the life easier and will avoid wasting time on things which are not
6-
requested. :sparkles:
3+
So, you want to contribute to this project? That's awesome! However, before doing so, please read the following simple steps on how to contribute. This will make life easier and avoid wasting time on things that are not requested. ✨
74

8-
## Discuss the changes before doing them
9-
- First of all, open an issue in the repository, using the [bug tracker][1],
10-
describing the contribution you would like to make, the bug you found or any
11-
other ideas you have. This will help us to get you started on the right
12-
foot.
5+
## Discuss the changes before making them
6+
To begin, open an issue in the repository using the [bug tracker][1]. Describe the contribution you'd like to make, the bug you've found, or any other ideas you have. This step will help us get you started on the right track.
137

14-
- If it makes sense, add the platform and software information (e.g. operating
15-
system, Node.JS version etc.), screenshots (so we can see what you are
16-
seeing).
8+
If it is relevant, include platform and software information (e.g., operating system, Node.JS version, etc.) and screenshots to help us understand what you're experiencing.
179

18-
- It is recommended to wait for feedback before continuing to next steps.
19-
However, if the issue is clear (e.g. a typo) and the fix is simple, you can
20-
continue and fix it.
10+
We recommend waiting for feedback before proceeding to the next steps. However, if the issue is clear, such as a typo, and the fix is simple, you can go ahead and fix it.
2111

22-
## Fixing issues
23-
- Fork the project in your account and create a branch with your fix:
24-
`some-great-feature` or `some-issue-fix`.
12+
## Fixing Issues
13+
Begin by forking the project to your own account, and create a branch for your fix, naming it either `some-great-feature` or `some-issue-fix`.
2514

26-
- Commit your changes in that branch, writing the code following the
27-
[code style][2]. If the project contains tests (generally, the `test`
28-
directory), you are encouraged to add a test as well. :memo:
15+
Commit your changes to that branch, adhering to the [code style][2]. If the project includes tests (usually located in the `test` directory), we encourage you to add a test as well. :memo:
2916

30-
- If the project contains a `package.json` or a `bower.json` file add yourself
31-
in the `contributors` array (or `authors` in the case of `bower.json`;
32-
if the array does not exist, create it):
17+
If the project includes a `package.json` or a `bower.json` file, add yourself to the `contributors` array (or `authors` in the case of `bower.json`). If the array doesn't exist, create it as shown below:
3318

34-
```json
35-
{
36-
"contributors": [
37-
"Your Name <and@email.address> (http://your.website)"
38-
]
39-
}
40-
```
19+
```json
20+
{
21+
"contributors": [
22+
"Your Name <your@email.address> (http://your.website)"
23+
]
24+
}
25+
```
4126

42-
## Creating a pull request
27+
## Creating a Pull Request
28+
Start by opening a pull request and make sure to reference the initial issue in the pull request message (e.g., *fixes #<your-issue-number>*). Provide a clear and descriptive title to help everyone understand what is being fixed or improved.
4329

44-
- Open a pull request, and reference the initial issue in the pull request
45-
message (e.g. *fixes #<your-issue-number>*). Write a good description and
46-
title, so everybody will know what is fixed/improved.
30+
If applicable, consider adding screenshots, gifs, or any other visual aids that can make it easier to understand the changes you've made.
4731

48-
- If it makes sense, add screenshots, gifs etc., so it is easier to see what
49-
is going on.
32+
## Wait for Feedback
33+
Before accepting your contributions, we will review them. You may receive feedback regarding what needs to be addressed in your modified code. If so, simply continue making commits to your branch, and the pull request will be automatically updated.
5034

51-
## Wait for feedback
52-
Before accepting your contributions, we will review them. You may get feedback
53-
about what should be fixed in your modified code. If so, just keep committing
54-
in your branch and the pull request will be updated automatically.
55-
56-
## Everyone is happy!
57-
Finally, your contributions will be merged, and everyone will be happy! :smile:
58-
Contributions are more than welcome!
35+
## Everyone Is Happy!
36+
Ultimately, your contributions will be merged, and everyone will be delighted! 😄 Contributions are more than welcome!
5937

6038
Thanks! :sweat_smile:
6139

62-
63-
64-
[1]: https://github.com/IonicaBizau/git-stats/issues
65-
40+
[1]: /issues
6641
[2]: https://github.com/IonicaBizau/code-style

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)