Making a pull request for a main distribution package for Racket

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.

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

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

4. 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

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

6. git remote add fork [email protected]:Metaxal/errortrace.git (This uses the ssh link, but it could be the https one)

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

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

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

git commit
git push remote fork

10. Go to https://github.com/Metaxal/errortrace and make the pull request.

Other resources:

• https://github.com/racket/racket/wiki/Ways-to-contribute-to-Racket
• https://www.greghendershott.com/2013/04/a-guide-for-infrequent-contributors-to-racket.html
• https://blog.racket-lang.org/2017/09/tutorial-contributing-to-racket.html
• https://alex-hhh.github.io/2018/01/changing-built-in-racket-packages.html