-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update setup.cfg description section to match input settings (#91)
* update setup.cfg description section to match input settings * Add python -m to README instructions * Fix broken links in contributing.md
- Loading branch information
Showing
5 changed files
with
9 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,10 +37,7 @@ on pre-commit hooks see our documentation][docs-pre-commit-hooks]. | |
|
||
### Git and GitHub | ||
|
||
We use Git to version control the source code. [Please read the GDS Way for details on | ||
Git best practice][gds-way-git]. This includes how to write good commit messages, use | ||
`git rebase` for local branches and `git merge --no-ff` for merges, as well as using | ||
`git push --force-with-lease` instead of `git push -f`. | ||
We use Git to version control the source code. [Please read the Quality assurance of code for analysis and research for details on Git best practice][duck-book-version-control]. This includes how to write good commit messages, how to branch correctly and solving merge conflicts. | ||
|
||
[If you want to modify the `.gitignore` files, see the template | ||
documentation][docs-updating-gitignore] for further details. | ||
|
@@ -123,7 +120,7 @@ the `README.md` file in that folder. | |
[docs-write-sphinx-documentation]: https://github.com/best-practice-and-impact/govcookiecutter/blob/main/%7B%7B%20cookiecutter.repo_name%20%7D%7D/docs/contributor_guide/writing_sphinx_documentation.md | ||
[email]: mailto:[email protected] | ||
[gds-way]: https://gds-way.cloudapps.digital/ | ||
[gds-way-git]: https://gds-way.cloudapps.digital/standards/source-code.html | ||
[gds-way-git]: https://www.gov.uk/service-manual/technology/maintaining-version-control-in-coding | ||
[gds-way-python]: https://gds-way.cloudapps.digital/manuals/programming-languages/python/python.html#python-style-guide | ||
[govcookiecutter]: https://github.com/best-practice-and-impact/govcookiecutter | ||
[myst]: https://myst-parser.readthedocs.io/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters