Skip to content

Instantly share code, notes, and snippets.

@Metaxal

Metaxal/readme.md

Last active July 1, 2023 12:50
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Metaxal/ded3e699fff33ca90996def967febc94 to your computer and use it in GitHub Desktop.
Save Metaxal/ded3e699fff33ca90996def967febc94 to your computer and use it in GitHub Desktop.
Download ZIP
Making a pull request for a main distribution package for Racket
Raw
readme.md

Making a pull request for a main distribution package

BETTER: https://blog.racket-lang.org/2017/09/tutorial-contributing-to-racket.html#how-to-contribute-to-a-main-distribution-package

Say we want to modify the docs of errortrace, which is bundled with the main distribution. I assume the system is a Unix.

  1. Install Racket from a binary as a local distribution, so you don't have to use sudo/root.

If you don't create symlinks, make sure you run the correct version of raco and friends below.

  1. Create a pkgs directory somewhere and cd to it.

  2. git clone https://github.com/racket/errortrace.git

  3. This is a multi collection package so we need to link several collections (in particular if you change the code and not just the docs):

cd errortrace
raco pkg update --link errortrace errortrace-lib errortrace-doc errortrace-test

  1. Fork the repo on github to, say https://github.com/Metaxal/errortrace

  2. git remote add fork git@github.com:Metaxal/errortrace.git (This uses the ssh link, but it could be the https one)

  3. Create a new branch git checkout -b my-edits

  4. Make your edits, test your changes (raco test), run raco setup errortrace.

  5. Commit and push the changes of the my-edits branch to your own github clone:

git commit
git push remote fork
  1. Go to https://github.com/Metaxal/errortrace and make the pull request.

Other resources:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment