Contributing
We welcome anyone to contribute to any part of this repository on Github. We've provided some answers to questions you might have, below. If you can't find an answer here, please ask in one of the following places:
Important Reading
We expect collaborators to adhere to TFP's Code of Conduct.
If you're planning on contributing to our code (website build or dataset scripts specifically) please read about our Architecture first.
If you're planning on introducing a significant change to our datasets, or a new one, please read about versioning.
Github Workflow
In order to make a change to our code or datasets in Github you'll need to:
- first fork the repository; then
- make a change on your fork; then
- open a Pull Request against our repo from the branch where you made your change
You can read Github's guide to the fork & PR workflow to learn more.
Working on the Website
We use docusaurus as our static website builder. Our content is written in an extended form of Markdown (MDX) which allows for embedding dynamic React components. You can find those under site/docs
.
Navigation links are managed in two locations:
site/sidebars
for the sidebar that shows on all pages aside from the homepagesite/docusaurus.config.js
for the header nav underthemeConfig.navbar.items