A big welcome and thank you for considering contributing to CSS' open source projects! We welcome anybody who wants to contribute, and we actively encourage everyone to do so, especially if you have never contributed before.
If you have never used git before, we would recommend that you read the GitHub's Getting Started guide. Additionally, linked below are some helpful resources:
If you are new to contributing to open-source projects on GitHub, the general workflow is as follows:
- Fork this repository and clone it
- Create a branch off master
- Make your changes
- Make sure to run
make fmtto autoformat your code - Make a commit with an explanatory commit message
- Make sure to run
- Push your local branch to your remote fork
- Open a new pull request on GitHub
We recommend also reading the following if you're unsure or not confident:
We use GitHub issues to track bugs and feature requests. If you find an issue with the website, the best place to report it is through the issue tracker. If you are looking for issues to contribute code to, it's a good idea to look at the issues labelled "good-first-issue"!
When submitting an issue, please be as descriptive as possible. If you are submitting a bug report, please include the steps to reproduce the bug, and the environment it is in. If you are submitting a feature request, please include the steps to implement the feature.
After you have found an issue which needs solving, it's time to start working on a fix! However, there are a few guidelines we would like you to follow first.
Where possible, new pages should be written in Markdown over raw HTML. This is for maintainability reasons, as it is easier to write and edit.
If you happen to be doing a lot of technical work on the website, the wiki has a few pointers on more technical aspects.
To enforce a consistent code style across files, we use prettier
to auto-format most of the code. This will automatically format your syntax to
a specific style - if it doesn't generate pretty code, then the code probably
needs a refactor and cleanup anyways. You can run prettier from within your IDE
(which will have it's own way of running it), or by using the make fmt helper
defined at the root of the repository.
In addition to the automatic formatter, follow the formatting style in the file you are editing.
Commit messages should be written in the imperative, present tense. For example, "Fix bug #1".
Additionally, we request that you keep the commit subject under 80 characters for a comfortable viewing experience on GitHub and other git tools. If you need more, please use the body of the commit.
For example:
Fix HTTP 418 error when navigating to /ball
<more detailed description here>
Once you have made your changes, please describe them in your pull request in full. We will then review them and communicate with you on GitHub. We may ask you to change a few things so please do check GitHub or your emails frequently.
After that, that's it! You've made your first contribution to CSS' website. 🎉
We aim to get more people involved with our website, and help build members' confidence in using git and contributing to open-source. If you see an error with the website, we encourage you to be bold and fix it yourself, rather than just raising an issue. If you are stuck, need help, or have a question about the website, the best place to ask is on our Discord, in the #website🌐 channel.
Happy editing!