Skip to content

Commit f25ae21

Browse files
committed
🩹 [just] merge only when already on a branch and copy edit docs
1 parent 5133309 commit f25ae21

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
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
44
with the hope that it is helpful to some folks. If you notice something that
55
could 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

3939
The [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

4342
The full development cycle works via the command line.
4443

4544
1. 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.
4847
1. Run `just pr` and it will create a PR based on your last commit message.
4948
1. Optionally, you can make other commits or update the PR description.
5049
1. 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
5658
just --list

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ A good starting place for new github repos.
1515
-[Issue Templates](.github/ISSUE_TEMPLATE)
1616
-[PR Template](.github/pull_request_template.md)
1717
-[CODEOWNERS](.github/CODEOWNERS)
18-
-[justfile](justfile) with command line workflow for pull requests
18+
-[justfile](justfile) with
19+
[command line workflow for pull requests](.github/CONTRIBUTING.md#development-process)
1920
-[Github Action for Markdownlint](.github/workflows)
2021
-[A few extra labels for issues](https://github.com/fini-net/template-repo/labels)
2122

@@ -30,7 +31,8 @@ A good starting place for new github repos.
3031
## Contibuting
3132

3233
- [Code of Conduct](.github/CODE_OF_CONDUCT.md)
33-
- [Contributing Guide](.github/CONTRIBUTING.md)
34+
- [Contributing Guide](.github/CONTRIBUTING.md) includes a step-by-step guide to our
35+
[development processs](.github/CONTRIBUTING.md#development-process).
3436

3537
## Support
3638

justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ pr: _on_a_branch
5858

5959
# merge PR and return to starting point
6060
[group('Process')]
61-
merge:
61+
merge: _on_a_branch
6262
gh pr merge -s -d
6363
just sync # mostly redundant, but just in case
6464

0 commit comments

Comments
 (0)