|
28 | 28 | - [How to Add Yourself](#-how-to-add-yourself) |
29 | 29 | - [YAML File Format](#-yaml-file-format) |
30 | 30 | - [Local Development](#-local-development-optional) |
31 | | -- [Git Workflow & Keeping in Sync](#-git-workflow--keeping-in-sync) |
32 | | -- [Contributing with GitHub CLI](#-contributing-with-github-cli) |
33 | 31 | - [Contribution Guidelines](#-contribution-guidelines) |
34 | 32 | - [Troubleshooting](#-troubleshooting--faq) |
| 33 | +- [Git Workflow & Keeping in Sync](#-git-workflow--keeping-in-sync) |
| 34 | +- [Contributing with GitHub CLI](#-contributing-with-github-cli) |
35 | 35 | - [License](#-license) |
36 | 36 |
|
37 | 37 | --- |
@@ -343,6 +343,118 @@ NextCommunity.github.io/ |
343 | 343 |
|
344 | 344 | --- |
345 | 345 |
|
| 346 | +## 🤝 Contribution Guidelines |
| 347 | + |
| 348 | +### Code of Conduct |
| 349 | + |
| 350 | +We're committed to providing a welcoming and inclusive environment. Please be respectful and professional in all interactions. |
| 351 | + |
| 352 | +### PR Review Process |
| 353 | + |
| 354 | +1. **Automated Checks**: Your PR will automatically run linting checks |
| 355 | +2. **Manual Review**: A maintainer will review your submission |
| 356 | +3. **Feedback**: You may be asked to make changes |
| 357 | +4. **Merge**: Once approved, your PR will be merged! |
| 358 | + |
| 359 | +### What Gets Approved? |
| 360 | + |
| 361 | +✅ **Yes:** |
| 362 | + |
| 363 | +- Complete, valid YAML files |
| 364 | +- Professional bios and appropriate content |
| 365 | +- Real GitHub profiles |
| 366 | +- Accurate information |
| 367 | + |
| 368 | +❌ **No:** |
| 369 | + |
| 370 | +- Spam or promotional content |
| 371 | +- Offensive or inappropriate material |
| 372 | +- Fake or duplicate profiles |
| 373 | +- Invalid YAML syntax |
| 374 | + |
| 375 | +### CI/CD Checks |
| 376 | + |
| 377 | +Every pull request runs automated checks: |
| 378 | + |
| 379 | +- **Linting**: Ensures YAML syntax is correct |
| 380 | +- **Build Test**: Verifies the site builds successfully |
| 381 | +- **Pre-commit Hooks**: Checks code quality |
| 382 | + |
| 383 | +If checks fail, you'll see error messages in the PR. Fix the issues and push again. |
| 384 | + |
| 385 | +--- |
| 386 | + |
| 387 | +## 🔧 Troubleshooting & FAQ |
| 388 | + |
| 389 | +### Common Issues |
| 390 | + |
| 391 | +#### ❌ Build Fails: "Invalid YAML" |
| 392 | + |
| 393 | +**Problem**: Your YAML file has syntax errors. |
| 394 | + |
| 395 | +**Solution**: |
| 396 | + |
| 397 | +- Check for proper indentation (use spaces, not tabs) |
| 398 | +- Ensure colons have a space after them (`name: John`, not `name:John`) |
| 399 | +- Use `|` for multi-line bio text |
| 400 | +- Validate your YAML at [yamllint.com](http://www.yamllint.com/) |
| 401 | + |
| 402 | +#### ❌ "GitHub username not found" |
| 403 | + |
| 404 | +**Problem**: The `github` field doesn't match a real GitHub profile. |
| 405 | + |
| 406 | +**Solution**: |
| 407 | + |
| 408 | +- Ensure you're using your exact GitHub username |
| 409 | +- Check for typos |
| 410 | +- Username is case-sensitive in this field |
| 411 | + |
| 412 | +#### ❌ My profile doesn't show up |
| 413 | + |
| 414 | +**Problem**: File naming or format issue. |
| 415 | + |
| 416 | +**Solution**: |
| 417 | + |
| 418 | +- File must be in `src/users/` directory |
| 419 | +- File must be named `username.yaml` (lowercase, with `.yaml` extension) |
| 420 | +- All required fields must be filled in |
| 421 | + |
| 422 | +#### ❌ Pre-commit hooks fail |
| 423 | + |
| 424 | +**Problem**: Code quality checks didn't pass. |
| 425 | + |
| 426 | +**Solution**: |
| 427 | + |
| 428 | +```bash |
| 429 | +# Install pre-commit |
| 430 | +pip install pre-commit |
| 431 | +
|
| 432 | +# Run checks manually |
| 433 | +pre-commit run --all-files |
| 434 | +``` |
| 435 | + |
| 436 | +### FAQ |
| 437 | + |
| 438 | +**Q: Can I update my profile after it's merged?** |
| 439 | +A: Yes! Just create a new PR with updates to your YAML file. |
| 440 | + |
| 441 | +**Q: How long does review take?** |
| 442 | +A: Usually within 24-48 hours, depending on maintainer availability. |
| 443 | + |
| 444 | +**Q: Can I add multiple social links?** |
| 445 | +A: Yes, all social fields (twitter, linkedin, instagram) are optional and independent. |
| 446 | + |
| 447 | +**Q: What if I don't have a personal website?** |
| 448 | +A: No problem! Just omit the `website` field or set it to your GitHub profile. |
| 449 | + |
| 450 | +**Q: Can I use emojis in my profile?** |
| 451 | +A: Yes, emojis are supported in the `name` and `bio` fields! 🎉 |
| 452 | + |
| 453 | +**Q: Is there a character limit for the bio?** |
| 454 | +A: No hard limit, but keep it concise (2-4 paragraphs recommended). |
| 455 | + |
| 456 | +--- |
| 457 | + |
346 | 458 | ## 🔀 Git Workflow & Keeping in Sync |
347 | 459 |
|
348 | 460 | Working with a forked repository means your copy can fall behind the upstream (the original NextCommunity repo) over time. This section explains the complete feature-branch workflow and the essential git commands every contributor should know. |
@@ -644,120 +756,6 @@ git push origin add-your-github-username |
644 | 756 |
|
645 | 757 | Once all checks pass and a maintainer approves the PR, it will be merged and your profile will go live! 🎉 |
646 | 758 |
|
647 | | ---- |
648 | | - |
649 | | -## 🤝 Contribution Guidelines |
650 | | - |
651 | | -### Code of Conduct |
652 | | - |
653 | | -We're committed to providing a welcoming and inclusive environment. Please be respectful and professional in all interactions. |
654 | | - |
655 | | -### PR Review Process |
656 | | - |
657 | | -1. **Automated Checks**: Your PR will automatically run linting checks |
658 | | -2. **Manual Review**: A maintainer will review your submission |
659 | | -3. **Feedback**: You may be asked to make changes |
660 | | -4. **Merge**: Once approved, your PR will be merged! |
661 | | - |
662 | | -### What Gets Approved? |
663 | | - |
664 | | -✅ **Yes:** |
665 | | - |
666 | | -- Complete, valid YAML files |
667 | | -- Professional bios and appropriate content |
668 | | -- Real GitHub profiles |
669 | | -- Accurate information |
670 | | - |
671 | | -❌ **No:** |
672 | | - |
673 | | -- Spam or promotional content |
674 | | -- Offensive or inappropriate material |
675 | | -- Fake or duplicate profiles |
676 | | -- Invalid YAML syntax |
677 | | - |
678 | | -### CI/CD Checks |
679 | | - |
680 | | -Every pull request runs automated checks: |
681 | | - |
682 | | -- **Linting**: Ensures YAML syntax is correct |
683 | | -- **Build Test**: Verifies the site builds successfully |
684 | | -- **Pre-commit Hooks**: Checks code quality |
685 | | - |
686 | | -If checks fail, you'll see error messages in the PR. Fix the issues and push again. |
687 | | - |
688 | | ---- |
689 | | - |
690 | | -## 🔧 Troubleshooting & FAQ |
691 | | - |
692 | | -### Common Issues |
693 | | - |
694 | | -#### ❌ Build Fails: "Invalid YAML" |
695 | | - |
696 | | -**Problem**: Your YAML file has syntax errors. |
697 | | - |
698 | | -**Solution**: |
699 | | - |
700 | | -- Check for proper indentation (use spaces, not tabs) |
701 | | -- Ensure colons have a space after them (`name: John`, not `name:John`) |
702 | | -- Use `|` for multi-line bio text |
703 | | -- Validate your YAML at [yamllint.com](http://www.yamllint.com/) |
704 | | - |
705 | | -#### ❌ "GitHub username not found" |
706 | | - |
707 | | -**Problem**: The `github` field doesn't match a real GitHub profile. |
708 | | - |
709 | | -**Solution**: |
710 | | - |
711 | | -- Ensure you're using your exact GitHub username |
712 | | -- Check for typos |
713 | | -- Username is case-sensitive in this field |
714 | | - |
715 | | -#### ❌ My profile doesn't show up |
716 | | - |
717 | | -**Problem**: File naming or format issue. |
718 | | - |
719 | | -**Solution**: |
720 | | - |
721 | | -- File must be in `src/users/` directory |
722 | | -- File must be named `username.yaml` (lowercase, with `.yaml` extension) |
723 | | -- All required fields must be filled in |
724 | | - |
725 | | -#### ❌ Pre-commit hooks fail |
726 | | - |
727 | | -**Problem**: Code quality checks didn't pass. |
728 | | - |
729 | | -**Solution**: |
730 | | - |
731 | | -```bash |
732 | | -# Install pre-commit |
733 | | -pip install pre-commit |
734 | | -
|
735 | | -# Run checks manually |
736 | | -pre-commit run --all-files |
737 | | -``` |
738 | | - |
739 | | -### FAQ |
740 | | - |
741 | | -**Q: Can I update my profile after it's merged?** |
742 | | -A: Yes! Just create a new PR with updates to your YAML file. |
743 | | - |
744 | | -**Q: How long does review take?** |
745 | | -A: Usually within 24-48 hours, depending on maintainer availability. |
746 | | - |
747 | | -**Q: Can I add multiple social links?** |
748 | | -A: Yes, all social fields (twitter, linkedin, instagram) are optional and independent. |
749 | | - |
750 | | -**Q: What if I don't have a personal website?** |
751 | | -A: No problem! Just omit the `website` field or set it to your GitHub profile. |
752 | | - |
753 | | -**Q: Can I use emojis in my profile?** |
754 | | -A: Yes, emojis are supported in the `name` and `bio` fields! 🎉 |
755 | | - |
756 | | -**Q: Is there a character limit for the bio?** |
757 | | -A: No hard limit, but keep it concise (2-4 paragraphs recommended). |
758 | | - |
759 | | ---- |
760 | | - |
761 | 759 | ## 📄 License |
762 | 760 |
|
763 | 761 | This project is licensed under the **GNU General Public License v3.0** - see the [LICENSE](LICENSE) file for details. |
|
0 commit comments