Skip to content

Commit

Permalink
Merge pull request #35 from IRNAS/release/v0.2.0
Browse files Browse the repository at this point in the history
Release v0.2.0
  • Loading branch information
MarkoSagadin committed Aug 1, 2023
2 parents 248c9df + e886ded commit 104ffdd
Show file tree
Hide file tree
Showing 34 changed files with 2,504 additions and 631 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report on what is not working but it should
title: BUG - <subject title related to the issue>
labels: 'type: bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**Firmware/Software Version**

**Hardware Version**

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'

**Additional context**
Add any other context about the problem here.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Feature request
about: Normal development issue on technical matters
title: "<subject title related to the issue>"
labels: 'type: feature request'
assignees: ''

---

## Context

<!--- Provide some context why is this feature needed.
Does it build from an existing feature, does it enable an implementation of some other new feature? -->

## Required steps / Implementation details

<!--- Either provide a list of steps that are required for this feature and/or provide technical details on how this feature will be implemented. -->

## Definition of Done

<!--- Explicitly define conditions when this feature request is considered done, so it can be reviewed and validated. -->
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/requirement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Requirement
about: Confirmed requirement for the project
title: "[USR001] - Requirement"
labels: ''
assignees: ''

---

**Mandatory:** yes/no

**Requirement description:**
A clear and concise description of the requirement

**Additional context**
Add any other context or technical information relevant to the requirement
31 changes: 31 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Description

<!--- A summary of the changes that this PR introduces. Provide a relevant motivation and context about this PR or link an issue that provides it. -->

Closes #
Related #

## Areas of interest for the reviewer

<!--- Which parts of the code should the code reviewer check? -->

## Checklist

<!--- Check items that you fulfilled, strikeout the ones that do not apply and write why -->
- [ ] My code follows the [style guidelines] as defined by IRNAS.
- [ ] I have performed a self-review of my code.
- [ ] My changes generate no new warnings.
- [ ] I added/updated source code documentation for all newly added or changed functions.
- [ ] I updated the CHANGELOG.
- [ ] I updated all customer-facing technical documentation.

Example strikeout:
- [ ] ~~I updated all customer-facing technical documentation.~~ - This PR introduced only internal facing changes.

## After-review steps

<!--- Delete section or select one option -->
* Reviewer can merge and delete the branch.
* I will merge PR by myself.

[style guidelines]: https://github.com/IRNAS/irnas-guidelines-docs/blob/dev/docs/developer_guidelines.md
2 changes: 2 additions & 0 deletions .gitlint
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[general]
ignore=body-is-missing, B6
32 changes: 31 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,34 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]

## [0.2.0] - 2023-08-01

### 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 to `docs/github_project_guidelines.md`.
- Various documents related to tooling, such as clang-format and gitlint, are
now in `tools` 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.

## [0.1.0] - 2022-05-12

### Added
Expand All @@ -22,6 +50,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Section about documentation.
- Extra readme for `.clang-format`

[Unreleased]: https://github.com/IRNAS/irnas-guidelines-docs/compare/v0.1.0...HEAD
[Unreleased]: https://github.com/IRNAS/irnas-guidelines-docs/compare/v0.2.0...HEAD

[0.2.0]: https://github.com/IRNAS/irnas-guidelines-docs/compare/v0.1.0...v0.2.0

[0.1.0]: https://github.com/IRNAS/irnas-guidelines-docs/compare/72adf4ac813c1915181b3cf15993ee44d90fa3ea...v0.1.0
Loading

0 comments on commit 104ffdd

Please sign in to comment.