|
| 1 | +# Contributing to Atlas Analytics Lab Website |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the Atlas Analytics Lab website! |
| 4 | + |
| 5 | +## For Lab Members |
| 6 | + |
| 7 | +If you're a lab member looking to update content (news, publications, team info), please see: |
| 8 | +- **Quick Guide:** [README.md](../README.md) |
| 9 | +- **Detailed Instructions:** [DEVELOPMENT.md](../DEVELOPMENT.md) - Git Workflow section |
| 10 | + |
| 11 | +## Reporting Issues |
| 12 | + |
| 13 | +Found a bug, typo, or have a suggestion? |
| 14 | + |
| 15 | +1. Check [existing issues](https://github.com/AtlasAnalyticsLab/AtlasAnalyticsLab.github.io/issues) first |
| 16 | +2. If it's new, [create an issue](https://github.com/AtlasAnalyticsLab/AtlasAnalyticsLab.github.io/issues/new) |
| 17 | +3. Provide as much detail as possible: |
| 18 | + - What page or section is affected? |
| 19 | + - What did you expect vs. what happened? |
| 20 | + - Screenshots if applicable |
| 21 | + |
| 22 | +## Submitting Pull Requests |
| 23 | + |
| 24 | +### Content Updates (News, Publications, Team) |
| 25 | + |
| 26 | +1. **Create a feature branch** from `main`: |
| 27 | + ```bash |
| 28 | + git checkout main |
| 29 | + git pull origin main |
| 30 | + git checkout -b feature/add-news-YYYY-MM-DD |
| 31 | + ``` |
| 32 | + |
| 33 | +2. **Make your changes:** |
| 34 | + - Edit `_data/news.yml` for news |
| 35 | + - Edit `_data/publications.yml` for publications |
| 36 | + - Edit `_data/[role].yml` for team members |
| 37 | + - Add images to appropriate `images/` subdirectory |
| 38 | + |
| 39 | +3. **Test locally:** |
| 40 | + ```bash |
| 41 | + bundle exec jekyll serve --livereload |
| 42 | + # Visit http://127.0.0.1:4000 |
| 43 | + ``` |
| 44 | + |
| 45 | +4. **Commit with descriptive message:** |
| 46 | + ```bash |
| 47 | + git add . |
| 48 | + git commit -m "content: add news about [topic]" |
| 49 | + git push origin feature/add-news-YYYY-MM-DD |
| 50 | + ``` |
| 51 | + |
| 52 | +5. **Open a pull request** on GitHub |
| 53 | + |
| 54 | +### Code/Layout Changes |
| 55 | + |
| 56 | +1. **Follow the same branch workflow** above |
| 57 | +2. **Test thoroughly** on different screen sizes and both themes (light/dark) |
| 58 | +3. **Update documentation** if you change structure or add features |
| 59 | +4. **Use semantic commit messages:** |
| 60 | + - `feat:` - New features |
| 61 | + - `fix:` - Bug fixes |
| 62 | + - `style:` - CSS/styling changes |
| 63 | + - `refactor:` - Code restructuring |
| 64 | + - `docs:` - Documentation updates |
| 65 | + - `chore:` - Maintenance tasks |
| 66 | + |
| 67 | +### Code Standards |
| 68 | + |
| 69 | +- **Indentation:** 2 spaces (HTML, CSS, JavaScript) |
| 70 | +- **Comments:** Follow standards in [DEVELOPMENT.md](../DEVELOPMENT.md) |
| 71 | +- **File headers:** Add descriptive headers to new files |
| 72 | +- **Test locally:** Always test before pushing |
| 73 | + |
| 74 | +## Review Process |
| 75 | + |
| 76 | +- All PRs require review before merging |
| 77 | +- Content updates: Quick review by Dr. Hosseini or designated team member |
| 78 | +- Code changes: More thorough review for functionality and style |
| 79 | +- Address review comments promptly |
| 80 | +- Squash commits if requested |
| 81 | + |
| 82 | +## Questions? |
| 83 | + |
| 84 | +For help: |
| 85 | +- **Jekyll/Technical:** [Jekyll Documentation](https://jekyllrb.com/docs/) or [Jekyll Talk Forums](https://talk.jekyllrb.com/) |
| 86 | +- **Lab Website:** Open an issue or contact Dr. Mahdi S. Hosseini at mahdi.hosseini@concordia.ca |
| 87 | + |
| 88 | +## License |
| 89 | + |
| 90 | +By contributing, you agree that your contributions will be licensed under the MIT License. |
0 commit comments