11# Contributing to this project
22
3- This has started as a personal project, but I am doing to publicly on github
3+ This has started as a personal project, but I am doing it publicly on github
44with the hope that it is helpful to some folks. If you notice something that
55could be better, please file an [ issue] ( ../../../issues ) .
66
@@ -23,7 +23,7 @@ unless a screen shot is the only way to convey your problem.
2323
2424- Major changes should probably be discussed in an [ issue] ( ../../../issues ) first.
2525- Fork the repo on github.
26- - Make a branch in your repo.
26+ - Make a branch in your branch on your repo.
2727- Add commits with good commit meessages.
2828- Open a pull request on github.
2929- Check the github actions on your PR to see if there's anything to fix.
@@ -37,20 +37,22 @@ unless a screen shot is the only way to convey your problem.
3737## Development process
3838
3939The [ justfile] ( ../justfile ) is used for centralizing snippets for build
40- and many other purposes. Run ` just ` anywhere in the repo to see which
41- subcommands are available here.
40+ and development purposes.
4241
4342The full development cycle works via the command line.
4443
45441 . Starting with a cloned repo, run ` just branch $some-name `
46- 1 . Make some changes and make sure your last commit message convey your overall
47- purpose.
45+ 1 . Make some changes and make sure your last commit message conveys your
46+ overall purpose.
48471 . Run ` just pr ` and it will create a PR based on your last commit message.
49481 . Optionally, you can make other commits or update the PR description.
50491 . Finally, ` just merge ` will merge the PR with squashed commit history and
5150 cleaned up branches locally and remotely. You'll end up with a repo back
5251 on ` main ` (release) branch with the latest ` git pull ` ed.
5352
53+ Run ` just ` anywhere in the repo to see which subcommands are available here.
54+ You should get a more colorful version of this:
55+
5456``` bash
5557% just
5658just --list
0 commit comments