Releases: IRNAS/irnas-guidelines-docs
Releases · IRNAS/irnas-guidelines-docs
v0.2.0
Release notes
Added
- Sections about code standards, code styles, documentation guidelines for
C/C++, Python and Rust. - File templates for C/C++ and Python.
- New document related to developer specific guidelines can be found in
docs/developer_guidelines.md
. It contains section about commits. - Documentation related to
gitlint
tool, it can be found in
tools/gitlint
. - Section about GitHub labels.
- Created
draft_ideas.md
file for storing unused work that might be useful
in the future.
Changed
- General project structure. Main README.md now serves as a landing page,
from where users can jump to other documents. Contents of the old README
were moved todocs/github_project_guidelines.md
. - Various documents related to tooling, such as clang-format and gitlint, are
now intools
directory. - Branching model to the Trunk-based development model from GitFlow.
- Moved Production versions section from project guidelines to the
draft_ideas.md
do to not using it. - Moved section about moving labels to the
draft_ideas.md
as it adds no
value and should be automated anyhow.
v0.1.0
Release notes
Added
CHANGELOG
file.README
file with basic structure.- Section about branching model.
- Section about repository naming scheme and versioning.
- Section about artifact naming.
- Section about changelog.
- Section about production versions.
- Section about releases.
- Section about resources.
- Section about documentation.
- Extra readme for
.clang-format