Skip to content

Commit

Permalink
update template
Browse files Browse the repository at this point in the history
  • Loading branch information
Sajtospoga01 committed Dec 18, 2023
1 parent 910ce61 commit 4d48f63
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/source/projects/template/template_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@
It is important to document a project for multiple reasons:
- One it helps current people better understand the code base and practiceses used in the team
- But two also helps new people get up to speed with the project and the team
- Helps you remember what you wrote

## What to document
## What to document here (teamdocs)
Anything really that you think is worth documenting. But here are some key points to look out for:
- How to setup, run the project(this usually included in the README.md of the project)

- How the team operates
- How to contribute to the project
- How to work as part of the team
- How code reviews are done
- How the team communicates
- How the team distributes work
Expand Down Expand Up @@ -76,6 +77,6 @@ This documentation should only contain the following:

>**Note:** It is important to create docstrings for everything you write. This isn't just helpfor for other people but helps you as well when months later you forgot what that piece of code was.
The autodoc pipeline is available the template repository, set for auto deploy on every push to the main branch.
The autodoc pipeline is available the template repository, set for auto deploy on every push to the main branch. Sample code is also provided under the [Conventions and Guidelines](../conventions_and_guidelines/conventions.md) section.

Code has to be documented the Sphinx documentation style.

0 comments on commit 4d48f63

Please sign in to comment.