Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/gh_repo_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Use pull requests for all changes to the codebase. Not only does this make changes safer, especially with regards to CI checks, but it also provides a clear history of changes made to the codebase. This is particularly useful for understanding the evolution of the code because it allows you to see what changes were made, when, and by whom. More than just `git blame`, many IDEs provide a way to view the history of the PR, including the discussions and commits that led to the final merged PR. This is invaluable not only for remembering your own work, but for documenting the codebase for others. *Even if you are working on a project alone, using a PR approach will prove invaluable at times.*

## General Repo Settings
## Opinionated Repo Settings

Use only Squash and Merge to keep a clean commit history. Use PR title and description to document the merge commit. Again, blame will allow you to find the PR and its discussion.

Expand All @@ -13,7 +13,7 @@ Use only Squash and Merge to keep a clean commit history. Use PR title and descr
You may also like:

- Always suggest updating pull request branches: Adds a button to update a PR with content from main -- useful for new contributors.
- Automaticly delete head branches: Automatically deletes the branch after merging a PR.
- Automatically delete head branches: Automatically deletes the branch after merging a PR.

## Branch Protection Rules

Expand Down
10 changes: 10 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ site_url: https://timmonko.github.io/urssi-docs/
theme:
name: material

nav:
- Overview: index.md
- Docs Deployment: docs_setup.md
- Repository Documentation: repo_setup.md
- GitHub Repo Settings: gh_repo_settings.md
- Documenting Code: docstrings.md
- Notebooks: notebooks.ipynb
- Versioning: versioning.md


markdown_extensions:
- admonition

Expand Down