Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 2.69 KB

contributing.md

File metadata and controls

49 lines (37 loc) · 2.69 KB
Raw

Contributing

Your feedback and pull requests are very welcome!

We use MkDocs + Material for MkDocs to build the website.

If you find a typo or other small textual error on a published page, select the "Edit this page" link at the bottom of the affected page. This link will take you to the right file on GitHub to make the edit and open a pull request.

For larger edits we recommend that you create a development environment, so that you can preview your work.

Creating a development environment

You have two options to get a development environment going:

  • Setup local workstation

Local workstation

To build the site locally on your workstation you'll need:

  • Node 20
  • npm 9 (comes pre-installed with Node 20)
  • Python 3.8

Follow these steps to setup your local development environment:

  1. Install the latest version of Python 3.8
  2. Install Node 20 (npm 9 is bundled with Node 20)
  3. Install Git, if you haven't already
  4. Make a fork of this repository via GitHub (select the "Fork" button)
  5. Clone your fork repository with git clone link_to_fork
  6. Tell Git that HonkingGoose/git-gosling is the upstream remote: git remote add upstream https://github.com/HonkingGoose/git-gosling.git
  7. Make sure you have all the data from the upstream remote by doing a git fetch --all --prune
  8. Do git merge upstream/main main to update your local main branch
  9. Make you're sure on the local main branch with git switch main (do not make your own commits on the local main branch!)
  10. Create a new branch to do your work on with git switch -c descriptive_name_for_branch
  11. Run npm ci to download and install all the dependencies for this project with npm
  12. Run make smoketest to ensure everything works before you start your work
  13. You can get a live preview with make serve, this starts a local development server and opens a browser window, most changes can be seen live without having to restart the server
  14. Make your changes
  15. When you're done, run the Prettier formatter with npm run prettier-fix
  16. Use the git add command to stage your work and commit with git commit -v
  17. Run the smoketest with make smoketest
  18. Push your local feature branch to your GitHub fork with git push --set-upstream origin descriptive_name_for_branch
  19. Open a pull request by going to this projects repository and going to the "Pull requests" tab
  20. GitHub will show your recently pushed branches here, and suggest you make a pull request, if your branch does not show up, select the "New pull request" button
  21. Your pull request will get reviewed, and if the maintainers like it, it will get merged.
  22. After your pull request is merged, you can remove your local branch with git branch -D branch_name