Skip to content

Commit

Permalink
Merge branch 'development' into eclesio/prosp-para-design
Browse files Browse the repository at this point in the history
  • Loading branch information
EclesioMeloJunior authored Dec 9, 2024
2 parents 2d1322b + 188b910 commit 70a92ad
Show file tree
Hide file tree
Showing 16 changed files with 195 additions and 172 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,8 @@ If a change does not alter any logic (e.g. comments, dependencies, docs), then i
### Labels
The set of labels and their description can be found [here](../docs/docs/repo/labels.md).
To change labels update [labels.yml](./labels.yml) file
The set of labels and their description can be found [labels.yml](/.github/labels.yml).
To change update this file and CI will automatically add/remove changed labels.
### Process
Expand Down
18 changes: 16 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'Type: Bug'
labels: 'T-bug'
assignees: ''

---

## Describe the bug
## Bug summary
<!-- A clear and concise description of what the bug is. -->

-
Expand Down Expand Up @@ -96,5 +96,19 @@ specification section if a specification is not applicable):
- operating system:
- additional links:

## Acceptance criteria
<!-- Acceptance criteria establish conditions to fulfill for the item to be complete. Usually can be a list of checkboxes.
Please refer to DOD for general implementation issue:
- There should be at least one unit test
- Recreate bug in deterministic way
- Regression test
- Bug is not reproducible anymore both deterministically and non-deterministically
Acceptance criteria should be added as a check boxes (eg [] Do this)
-->
[] Bug was recreated in deterministic manner
[] Unit test that covers the problem
[] Regression test done
[] Bug is not reproducible anymore


<!-- Thank you 🙏 -->
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Epic
about:
title: 'collection of business/tech scope'
labels: 'Epic'
assignees: ''
---
## Epic summary
<!-- A clear and concise description of what the Epic is about. -->
-

## Links to related tech. design or research documents
<!-- Add any other context, links or screenshots about the issue here. -->
-

## Sub issues
<!-- Mention sub issues here so people without ZenHub can see them -->
-

## Acceptance criteria
<!--Acceptance criteria establish conditions to fulfill for the item to be complete. Usually can be a list of checkboxes
Please refer to DOD for general implementation issue:
- Regression testing of the feature. You might create regression testing issue separately within an Epic if necessary testing is complex by itself
- Feature is complete and confirmed by Tech. lead and one more team member
-->
[] Feature is complete and confirmed by Tech. lead and one more team member
[] Regression testing done


<!-- Thank you 🙏 -->
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/general_report.md

This file was deleted.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/implementation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Implementation
about: General purpose issue template can be used pretty much for every implementation
title: 'Implement ... '
labels: 'T-implementation'
assignees: ''

---

## Issue summary
<!-- A clear and concise description of what the task is. -->
-

## Implementation details
<!-- How this issue should be addressed. -->
-

## Other information and links
<!-- Add any other context, links or screenshots about the issue here. -->
-

## Acceptance criteria
<!-- Acceptance criteria establish conditions to fulfill for the item to be complete. Usually can be a list of checkboxes.
Please refer to DOD for general implementation issue:
- AC should be complete so list everything that this issue suppose to have
- 60% test coverage. No less then 60% of coverage for newly added lines
- If applicable Regression testing. If this issue can be tested by its won mention Regression testing.
Acceptance criteria should be added as a check boxes (eg [] Do this)
-->
[] Add AC's here..
[] Regression testing (if applicable)
[] New code is 60% covered with unit tests

<!-- Thank you 🙏 -->
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/investigation_or_research.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Investigation
about:
title: ' Investigate/ Research on ...'
labels: 'T-investigation'
assignees: ''
---

## Summary
<!-- A clear and concise description of what should be investigated or researched. -->

## Related resources
<!-- List of additional resource that might be useful when doing research or investigation -->

## Acceptance criteria
<!-- Acceptance criteria in terms of investigation or research usually (but not only) should consist of:
- list of open questions that need to be answered
- some summary, research paper or meta knowledge as an outcome of research or investigation
- at least two people sign off. One of them is the Tech lead second should be decided with team
- workshop or knowledge sharing session should be conducted to share outcomes
-->
[] add open questions here..
[] Summary, research paper or meta knowledge written and merged to main repo (if applicable)
[] Tech lead sign off
[] Team member sign off (mention who)
[] Workshop or knowledge session conducted if needed
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/software_design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Software Design
about:
title: 'Design ...'
labels: 'T-design'
assignees: ''
---

## Scope
<!-- Clarify what the design or architecture should cover (e.g., a system, feature, component, or entire product). -->

## Functional Requirements
<!-- A list of functional specifications the system or feature must fulfill. Use cases or user stories demonstrating expected behavior. -->

## Non-Functional Requirements
<!-- If applicable provide Performance, Scalability, Security or other metrics and characteristics of module to design -->


## Related resources
<!-- List resources that might be useful during design/research -->


## Acceptance criteria
<!-- Acceptance criteria in terms of design or architecture usually (but not only) should consist of:
- at least two people sign off. One of them is the Tech lead second should be decided with team
- workshop or knowledge sharing session should be conducted to share outcomes of Design
- Software design artifacts provided (eg flow chart, use case, pseudocode)
- After design have been confirmed issues should be created and estimated
-->
[] Summary, design paper or meta knowledge written and merged to main repo
[] Artifacts produced
[] Tech lead sign off
[] Team member sign off (mention who)
[] Workshop or knowledge session conducted
[] Issues created and estimated (if necessary)
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/task_report.md

This file was deleted.

35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/user_story.yml

This file was deleted.

34 changes: 17 additions & 17 deletions .github/labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
description: pull request with next release changes.

# Action/attention needed label. Marks that there is a specific action needed for issue/PR
- name: A-in-QA-or-regression
color: "#8ceac8"
aliases: []
description: pull request or issues is currently in QA or regression testing phase.

- name: A-tooBig
color: "#FBCA04"
aliases: []
Expand All @@ -47,46 +52,41 @@
aliases: []
description: issue requires detective debug work to figure out what's going wrong.

- name: A-design
color: "#FBCA04"
aliases: []
description: issue requires design work to think about how it would best be accomplished.

# Describes the type of issue or pull request.
- name: T-bug
color: "#FEF2C0"
aliases: []
description: this issue covers unexpected and/or wrong behaviour.

- name: T-feat
- name: T-implementation
color: "#FEF2C0"
aliases: []
description: this issue/pr is a new feature or functionality.

- name: T-enhancement
- name: T-research
color: "#FEF2C0"
aliases: []
description: this issue/pr covers improvement of existing functionality.
description: this issue/pr is a research type issue.

- name: T-refactor
- name: T-investigation
color: "#FEF2C0"
aliases: []
description: this issue/pr covers refactoring of existing code.
description: this issue/pr is an investigation, probably related to some bug with unknown causes.

- name: T-security
- name: T-design
color: "#FEF2C0"
aliases: []
description: this issue/pr covers security sensitive problem.
aliases: [ ]
description: this issue describes design requirements

- name: T-research
- name: T-refactor
color: "#FEF2C0"
aliases: []
description: this issue/pr is a research type issue.
description: this issue/pr covers refactoring of existing code.

- name: T-investigation
- name: T-security
color: "#FEF2C0"
aliases: []
description: this issue/pr is an investigation, probably related to some bug with unknown causes.
description: this issue/pr covers security sensitive problem.

- name: T-question
color: "#FEF2C0"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ jobs:
- name: Generate coverage report
run: |
go test ./... -coverprofile=coverage.out -covermode=atomic -timeout=20m
- uses: codecov/codecov-action@v5.0.7
- uses: codecov/codecov-action@v5.1.1
with:
files: ./coverage.out
flags: unit-tests
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ jobs:
- name: Test - Race
run: make test-using-race-detector

- uses: codecov/codecov-action@v5.0.7
- uses: codecov/codecov-action@v5.1.1
with:
if_ci_failed: success
informational: true
Expand Down
Loading

0 comments on commit 70a92ad

Please sign in to comment.