Contributing to the kit
File an issue
The best way to request new features, flag a bug you’ve discovered or ask for updates to docs or templates is to create an issue on the graphics kit repo.
Be sure you’ve searched through open and previously closed issues on the repo to make sure yours hasn’t already been addressed.
Contributing changes
All Reuters graphics staff are welcome to contribute changes to graphics kit code, AI templates and documentation, directly.
-
Make sure you have the latest version of the graphics kit cloned to a local repo on your computer.
-
Create a new branch for your contribution.
Terminal window git checkout -b my-new-feature -
Create changes to the kit on your local branch and commit them.
Terminal window git commit -am "Cool new feature that does something awesome" -
The graphics kit uses changesets for versioning and to update our changelog. You should generally make a
patch
changeset unless specifically asked to make a more serious change by one of the project maintainers.Terminal window pnpm changeset -
Push your new branch to the repo and create a pull request in GitHub.
Terminal window git push origin my-new-feature
Working with graphics kit docs
Graphics kit documentation is created with the Astro Starlight framework.
To work on documentation, run the following command and then edit the appropriate .mdx
page in the docs/
directory:
pnpm astro dev