Skip to content

Commit

Permalink
Add protect main branch to repo setup
Browse files Browse the repository at this point in the history
  • Loading branch information
clizbe authored and abelsiqueira committed Oct 29, 2024
1 parent 4801d34 commit 232e4af
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/src/10-full-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,21 @@ Before releasing, enable Zenodo integration at <https://zenodo.org/account/setti

Enable GitHub discussions.

### Protect the main branch

If you are working with others, we recommend to protect your main branch, require approvals of pull requests before merging, and enforce a linear history.

1. On GitHub, navigate to the main page of your repository.
1. Under your repository name, click **Settings**.
1. In the left menu, click **Branches**.
1. Next to "Branch protection rules," click **Add rule**.
1. Under "Branch name pattern," type the branch name that you want to protect, in this case "main."
1. Select these options:
- [x] Require a pull request before merging
- [x] Require approvals
- [x] Require linear history
1. Click **Create**

### First release

When you are ready to make your first release, enable the [Julia Registrator bot](https://github.com/apps/juliateam-registrator/installations/select_target).
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ CurrentModule = BestieTemplate

![BestieTemplate.jl](assets/logo.png)

Welcome to the documentation of BestieTemplate.jl. This package provides a template in the [copier](https://copier.readthedocs.io) engine for a Julia package. Furthermore, it provides a wrapper around convenience calls to that package.
Welcome to the documentation of [BestieTemplate.jl](https://github.com/JuliaBesties/BestieTemplate.jl). This package provides a template in the [copier](https://copier.readthedocs.io) engine for a Julia package. Furthermore, it provides a wrapper around convenience calls to that package.

The main features of this package/template are:

Expand Down

0 comments on commit 232e4af

Please sign in to comment.