Sorry. I shouldn’t assume everyone knows about pull requests, git, version control and git repository hosting services like github.
It sounds like a lot of weird jargon but - bear with me - it is actually quite useful. There was I time when I did not know about this and I’m grateful for the people who explained it to me.
Git is version control software that makes it easier for groups to collaborate on software projects consisting of many source code files. You might use the version functions in Microsoft word or similar. This is similar but works with many more people and documents (source files) at the same time.
Git is not perfect and a subject of research to make it better. Design and usability are important. (I have a sticker on my laptop ‘usability is a clinical safety issue’) despite the problems with git it remains one of the best tools we have to let many people collaborate on software projects.
There are a number of git hosting services that help make it easier to use by providing a web interface.
Racket uses GitHub, but there are others like GitLAB.
In git, a collection of files being managed as a group is called a repository.
The way you propose a change is to make a pull request. Services like GitHub let you use a web interface to create pull requests. You don’t normally use the web interface but it is fine for adding files and updating markdown documents because GitHub has markdown editing support.
So that is the background. To actually do it
- Got to GitHub.com and make a free account
- Go to GitHub - Racket-Cookbooks/Plot-cookbook: Plot Cookbook
- Click create new file
- Type examples/f1/f1.md
- On the first line type
- On the second line type a description
- Save the file
There will be some stuff about not having write access; the outcome is you have taken a copy of the plot-cookbook in your GitHub account
The copy will be a branch normally called
patch-1 (The first time), and will be in the top left of your copy of the Plot-cookbook repository.
- You can click on the
examples/f1/ folder and drag and drop the other files you need to include.
- Click the green
create pull request button
- Follow the steps, include a description
submit and you are done.
Now I’ve written it out it seems like a lot of steps.
If I do this one can you check it for me?