|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -Thanks for your interest in contributing! Basic workflow: |
| 3 | +Thanks for your interest in contributing! We welcome first-time contributors and maintain a friendly, beginner-focused workflow. |
4 | 4 |
|
5 | | -- Fork the repo, create a branch, make changes, open a PR. |
| 5 | +## Basic workflow |
6 | 6 |
|
7 | | -Previewing the website locally: |
| 7 | +- Fork the repo |
| 8 | +- Create a topic branch (git checkout -b feature/your-feature) |
| 9 | +- Make changes, commit, push to your fork |
| 10 | +- Open a Pull Request (PR) |
8 | 11 |
|
9 | | -1. From the repository root run: |
| 12 | +We have templates to help: issue templates and a PR template are available in `.github/`. |
| 13 | + |
| 14 | +## Previewing the website locally |
| 15 | + |
| 16 | +You can preview the static site using a simple HTTP server. Below are cross-platform instructions. |
| 17 | + |
| 18 | +Windows (PowerShell): |
| 19 | + |
| 20 | +```powershell |
| 21 | +# From repository root |
| 22 | +python -m http.server 8000 |
| 23 | +# or, if python is python3 on your system: |
| 24 | +python3 -m http.server 8000 |
| 25 | +``` |
| 26 | + |
| 27 | +macOS / Linux: |
10 | 28 |
|
11 | 29 | ```bash |
12 | 30 | python3 -m http.server 8000 |
13 | 31 | ``` |
14 | 32 |
|
15 | | -2. Open http://localhost:8000/index.html |
| 33 | +Then open http://localhost:8000/index.html in your browser. |
16 | 34 |
|
17 | | -Website deployment branch: |
| 35 | +## PR Checklist |
| 36 | + |
| 37 | +Before submitting a PR, please make sure: |
| 38 | + |
| 39 | +- [ ] Your PR has a clear title and description explaining the change |
| 40 | +- [ ] You followed the coding / formatting style used in the repo |
| 41 | +- [ ] You updated documentation or README if required |
| 42 | +- [ ] You created or updated tests where appropriate (small projects may not have tests) |
| 43 | +- [ ] You linked any related issue (use the issue templates to open new ones) |
| 44 | + |
| 45 | +## Website deployment branch |
18 | 46 |
|
19 | 47 | - A branch named `website-pages` is used to host the static site for GitHub Pages. You can create a PR from this branch to `main` or configure Pages to publish from it directly. |
20 | | -- To preview the site from that branch locally, check out the branch and run the simple HTTP server. |
| 48 | +- To preview the site from that branch locally, check out the branch and run the simple HTTP server as shown above. |
| 49 | + |
| 50 | +## Community and code of conduct |
| 51 | + |
| 52 | +Please follow the project's `CODE_OF_CONDUCT.md`. |
| 53 | + |
| 54 | +If you are unsure about a change, open an issue first or join the community WhatsApp linked in the README. |
| 55 | + |
0 commit comments