|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +Thank you for your interest in contributing to this project! 🎉 |
| 4 | + |
| 5 | +## How the New System Works |
| 6 | + |
| 7 | +This project now uses individual contributor files instead of a single `data.json` file. This means: |
| 8 | + |
| 9 | +- **No More Merge Conflicts**: Each contributor creates their own file, eliminating conflicts between pull requests |
| 10 | +- **Simple Process**: Just create a JSON file with your information |
| 11 | +- **Automatic Build**: GitHub Actions automatically rebuilds the `data.json` file when changes are merged |
| 12 | + |
| 13 | +## File Structure |
| 14 | + |
| 15 | +Your contributor file should be named `contributors/{your-github-username}.json` and follow this format: |
| 16 | + |
| 17 | +```json |
| 18 | +{ |
| 19 | + "github": "your-github-username", |
| 20 | + "photo": "https://github.com/your-github-username.png", |
| 21 | + "quote": "Your favorite quote here" |
| 22 | +} |
| 23 | +``` |
| 24 | + |
| 25 | +### Fields |
| 26 | + |
| 27 | +- **github** (required): Your GitHub username |
| 28 | +- **photo** (optional): URL to your profile photo. If omitted, your GitHub avatar will be used automatically |
| 29 | +- **quote** (required): Your favorite quote or a message |
| 30 | + |
| 31 | +## Step-by-Step Guide |
| 32 | + |
| 33 | +1. **Fork the repository** - Click the "Fork" button at the top right |
| 34 | +2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/first-contribution.git` |
| 35 | +3. **Create a branch** - `git checkout -b add-your-name` |
| 36 | +4. **Create your file** - Add `contributors/your-username.json` with your information |
| 37 | +5. **Commit** - `git add contributors/your-username.json && git commit -m "Add YOUR-NAME to contributors"` |
| 38 | +6. **Push** - `git push origin add-your-name` |
| 39 | +7. **Create a Pull Request** - Go to GitHub and create a PR from your branch |
| 40 | + |
| 41 | +## What Happens After You Submit? |
| 42 | + |
| 43 | +1. Your PR will be reviewed |
| 44 | +2. Once approved and merged, GitHub Actions will automatically run |
| 45 | +3. The `data.json` file will be regenerated from all contributor files |
| 46 | +4. Your name will appear on the contributors page! |
| 47 | + |
| 48 | +## Need Help? |
| 49 | + |
| 50 | +- Check `contributors/TEMPLATE.json` for an example |
| 51 | +- Look at existing files in the `contributors/` directory |
| 52 | +- Open an issue if you have questions |
| 53 | +- Ask for help in your pull request comments |
| 54 | + |
| 55 | +## Building Locally (Optional) |
| 56 | + |
| 57 | +If you want to test the build process locally: |
| 58 | + |
| 59 | +```bash |
| 60 | +npm run build |
| 61 | +``` |
| 62 | + |
| 63 | +This will regenerate `data.json` from all the contributor files. |
| 64 | + |
| 65 | +--- |
| 66 | + |
| 67 | +Happy Contributing! 🚀 |
0 commit comments