Skip to content

Contributing to master

Markulf Kohlweiss edited this page Dec 14, 2017 · 5 revisions

Contributing to master

FStar master is locked and can only be changed through a pull request that passes continuous integration (CI) tests.

Here is the quickest way to push changes, e.g., for fixing typos in the tutorial.

git checkout -b <your-slack-alias>_<rest-of-branch-name>

Adding your slack alias adds notification about CI progress in the slackbot channel.

Then use the usual git add, git commit, git push. This will trigger CI to be run.

After creating a new branch you may have to run git push --set-upstream origin <your-slack-alias>_<rest-of-branch-name>, but git will remind you.

Open your branch in github by clicking on branch:Master, click Pull requests, New pull request.

Creating the pull request will trigger CI to be run a second time. Once this run finished you can merge your branch with master and delete it, all through the github user interface.

If you are the only one editing your branch, be sure to rebase: git rebase master.

Clone this wiki locally