Contributing

Thank you for your interest in contributing to the berkeley-class-site template.

How to Contribute

You can propose changes to the course website by:

Forking this repository
See GitHub’s guide on forking:
https://help.github.com/articles/fork-a-repo/ It is also perfectly acceptable to work on a branch if you have write access to this repository. Reach out to maintainers if you'd like write access.
Making edits in your fork or branch Examples of useful contributions include:
- Fixing typos and broken features.
- Implementing new features that will be useful for all courses. Course specific features are best implemented in your course's repository. If you're unsure, please open an issue to start a discussion.
- Anything that addresses an open issue.
- Improved documentation that accounts for personal experience using the template
Submitting a Pull Request
Learn more about pull requests here:
https://help.github.com/articles/about-pull-requests/

Please include:
- A clear description of what you changed
- The motivation for the change
- Any relevant context or screenshots
Ensure that your pull request also includes documentation for your changes. Documentation lives in the docs directory and is intended for users of the template (e.g. instructors and course staff).

Aim for singular, focused updates. If your contribution spans multiple features, consider submitting separate PRs. For complex overhauls that can’t be easily split, please keep maintainers in the loop to ensure a smooth merge.
Follow the existing style and structure of the site.
Use inclusive language, both in your documentation and code.
Test all changes locally and ensure that the automated accessibility checks and linting pass.