Skip to content

Commit 0af815e

Browse files
committed
chore(3.0): add CONTRIBUTION rules
1 parent 92fdfd5 commit 0af815e

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

CONTRIBUTING.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing to @ekino/logger 🌟
2+
3+
First and foremost, thank you for considering a contribution to this project! 💖
4+
5+
Your time and effort make a difference, and every pull request, no matter the size, helps move this project forward.
6+
7+
Whether you're fixing a bug, adding a new feature, or improving documentation, your input is valuable. If you're new to open source, welcome! 🎉
8+
9+
Don't worry if you feel unsure about where to start—every bit of help is appreciated, and questions are welcome.
10+
11+
## How to Contribute
12+
13+
Follow this guide to ensure a smooth contribution process. If you're planning significant work or substantial changes, please create an issue labeled "contribution enquiry" to discuss your proposal. This will help ensure that your work aligns with the project's goals.
14+
15+
### Steps to Get Started
16+
17+
1. **Fork the Repository**
18+
Start by [forking the repository](http://help.github.com/fork-a-repo/).
19+
20+
2. **Clone Your Fork**
21+
Clone your forked repo to your local machine:
22+
```bash
23+
git clone git@github.com:ekino/node-logger.git
24+
```
25+
26+
3. **Set Upstream**
27+
Link back to the main project repository:
28+
```bash
29+
git remote add upstream git://github.com/ekino/node-logger.git
30+
```
31+
32+
4. **Sync With Upstream**
33+
Fetch the latest changes from upstream, usually the main development branch:
34+
```bash
35+
git pull upstream <dev-branch>
36+
```
37+
38+
5. **Create a Topic Branch**
39+
Create a new branch for your feature, fix, or enhancement:
40+
```bash
41+
git checkout -b <topic-branch-name>
42+
```
43+
44+
6. **Write Tests**
45+
Ensure your changes are reliable by including tests. For small patches, a simple test is fine; for new features, create a dedicated test suite.
46+
47+
7. **Coding Style and Conventions**
48+
Maintain the project’s coding standards. Consistent indentation, comments, and style improve readability.
49+
50+
8. **Commit Changes in Logical Chunks**
51+
Split your commits into logical parts. Use git’s [interactive rebase](https://help.github.com/articles/interactive-rebase) to keep your commit history clean.
52+
53+
9. **Merge With Upstream**
54+
Sync your branch with the latest upstream changes:
55+
```bash
56+
git pull --rebase upstream <dev-branch>
57+
```
58+
59+
10. **Push to Your Fork**
60+
Push your topic branch to your fork:
61+
```bash
62+
git push origin <topic-branch-name>
63+
```
64+
65+
11. **Create a Pull Request**
66+
Open a [Pull Request](http://help.github.com/send-pull-requests/) with a clear title and description, explaining why and how you made your changes.
67+
68+
### Guidelines for a Successful Contribution
69+
70+
- **Focused Scope**: Keep your PR focused; avoid unrelated changes.
71+
- **Commit Messages**: Write meaningful commit messages. See [this guide](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for best practices.
72+
- **Style Consistency**: Follow the project’s formatting and coding style.
73+
- **Documentation**: Update documentation or comments as needed to explain your changes.
74+
75+
### Need Help?
76+
77+
If anything is unclear, or if you're facing any issues while contributing, please don’t hesitate to [open an issue](https://github.com/ekino/node-logger/issues/new/choose). We're here to help!

0 commit comments

Comments
 (0)