Skip to content

Commit 7b26341

Browse files
authored
Merge pull request #1 from OpenCodeChicago/Alexandrbig1-patch-2
Enhance contributing guidelines in CONTRIBUTING.md
2 parents 97f204b + 6c18cff commit 7b26341

1 file changed

Lines changed: 87 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 87 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,98 @@
11
# Contributing Guidelines
22

3-
Thank you for considering contributing to **Open Code Chicago**!
4-
We welcome contributions of all skill levels.
3+
Thank you for considering contributing to **Open Code Chicago**!
4+
We welcome contributions of all skill levels.
5+
6+
---
7+
8+
## Before You Start
9+
- Please read our [Code of Conduct](./CODE_OF_CONDUCT.md)
10+
- Check out the [Usage Guide](./docs/usage.md) to run the project locally
11+
- Look at [open issues](https://github.com/OpenCodeChicago/hacktoberfest-2025-infra/issues) to see where you can help
12+
- Review our [Project Board](https://github.com/orgs/OpenCodeChicago/projects/2) to see **available tasks**
13+
- Comment on the task you’d like to work on so a maintainer can assign it to you
14+
- This helps avoid duplicate work and keeps efforts coordinated
15+
16+
---
517

618
## How to Contribute
7-
- Fork the repository and create a new branch
8-
- Make your changes and commit with clear messages
9-
- Open a Pull Request (PR) to the `main` branch
10-
- Reference any related issues in your PR
19+
1. **Fork** the repository
20+
2. **Pick a task** from the [Project Board](https://github.com/orgs/OpenCodeChicago/projects/2) or from [open issues](https://github.com/OpenCodeChicago/hacktoberfest-2025-infra/issues)
21+
- Comment to claim it before starting work
22+
3. **Create a branch** for your work (e.g. `feature/awesome-feature` or `fix/typo`)
23+
4. **Make your changes** and commit with clear, descriptive messages
24+
5. **Open a Pull Request (PR)** to the `main` branch
25+
- Reference any related issues (e.g. `Closes #123`)
26+
- Keep PRs small and focused — easier to review and merge
27+
28+
---
1129

1230
## Guidelines
13-
- Follow our [Code of Conduct](./CODE_OF_CONDUCT.md)
14-
- Use clear, descriptive commit messages
15-
- Keep PRs focused on a single change (small & clear)
16-
- Write clean, well-documented code
17-
- If possible, include tests for new features
31+
- Use clear, descriptive commit messages
32+
- Keep your PR focused on a single change
33+
- Follow code style (Prettier config is included in the project)
34+
- Run `npm run lint` before pushing
35+
- Write clean, well-documented code
36+
- Add/update tests if relevant
37+
38+
---
39+
40+
## Dependencies & Packages
41+
- All dependencies are tracked in `package.json`.
42+
- Please **do not install or commit new packages** without first discussing in an issue or PR.
43+
- If you believe a new dependency is required:
44+
1. Open or comment on an issue explaining why it’s needed.
45+
2. Wait for maintainer approval before adding it.
46+
- The `node_modules` folder should **not** be committed — it is auto-generated by `npm install`.
47+
- Always run `npm install` after cloning the repo to get the correct dependencies.
48+
49+
---
50+
51+
## Get Recognized with the All-Contributors Bot
52+
We use the [All Contributors Bot](https://allcontributors.org/docs/en/bot/usage) to recognize and celebrate all types of contributions.
53+
54+
**How to add yourself:**
55+
1. After your Pull Request is merged, comment on the PR or in a new issue with:
56+
```
57+
@all-contributors please add @your-github-username for code, doc, ideas
58+
```
59+
- Replace `@your-github-username` with your GitHub handle.
60+
- List your contribution types (e.g., `code`, `doc`, `ideas`, `bug`, `review`).
61+
- [See all contribution types here.](https://allcontributors.org/docs/en/emoji-key)
62+
63+
2. The bot will create a Pull Request to add you to the contributors table in the README.
64+
3. A maintainer will review and merge the bot’s PR.
65+
66+
**Example:**
67+
```
68+
@all-contributors please add @Alexandrbig1 for code, doc, maintenance, projectManagement
69+
```
70+
71+
If you have questions, ask in your PR or open an issue!
72+
73+
---
1874

1975
## Issues
20-
- Use issues to report bugs, request features, or ask questions
21-
- Before opening a new issue, check if it already exists
22-
- Tag issues with labels (e.g., `bug`, `enhancement`, `good first issue`)
76+
- Use issues to report bugs, request features, or ask questions
77+
- Before opening a new issue, check if it already exists
78+
- Apply labels when possible (`bug`, `enhancement`, `good first issue`)
79+
80+
---
2381

2482
## Getting Help
25-
If you’re stuck or unsure, feel free to reach out via our [Email](mailto:info@opencodechicago.org).
83+
If you’re stuck or unsure:
84+
- Ask in our [GitHub Discussions](https://github.com/orgs/OpenCodeChicago/discussions/2)
85+
- Join our [Discord](https://discord.gg/t6MGsCqdFX)
86+
- Or email us at [info@opencodechicago.org](mailto:info@opencodechicago.org)
87+
88+
---
89+
90+
## ⭐ Support the Project
91+
92+
If you find this project helpful or enjoy contributing, please consider giving us a ⭐ on GitHub!
93+
Starring the repo helps increase its visibility, attracts more contributors, and makes your contributions more visible and valuable for your portfolio or employer. Thank you for supporting open source!
94+
95+
---
2696

27-
Every contribution matters — big or small.
97+
Every contribution matters — big or small. ❤️
98+
Thank you for helping make Open Code Chicago better!

0 commit comments

Comments
 (0)