Skip to content

Conversation

@Bahati308
Copy link
Contributor

  • Add bug report template with component selection
  • Add feature request template
  • Configure to prevent blank issues
  • Add links to documentation and discussions

- Add bug report template with component selection
- Add feature request template
- Configure to prevent blank issues
- Add links to documentation and discussions
@r0ssing
Copy link
Contributor

r0ssing commented Nov 26, 2025

Should we consider adding a section for "User stories" or some other way to test/reproduce if it is a bug?

@Bahati308
Copy link
Contributor Author

Should we consider adding a section for "User stories" or some other way to test/reproduce if it is a bug?
indeed it would be good to have it, lemme include it ASAP.

…eria

Add optional User Story, Details, and Acceptance Criteria sections to
improve bug reproduction and testing capabilities.
@Bahati308 Bahati308 marked this pull request as ready for review November 27, 2025 09:28
@Ndacyayisenga-droid Ndacyayisenga-droid added the feature New functionality or capability label Nov 27, 2025
Copy link
Contributor

@r0ssing r0ssing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Contributor

@IamLRBA IamLRBA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Bahati308, these additions look really good and they match the Github standards.
Perhaps what other mature projects include that we might add are:

  • Severity: critical, major, minor, low
  • Priority: P0–P3
    These help triage bugs quickly.

Maybe in addition to that:

  • You added additional context, but many teams make this explicit: They can upload images or videos showing the issue.

  • You included environment/version in Bug Report, but not for feature requests.

  • Another optional but Helpful one is to add a "Checklist Before Submitting" e.g

  • I have searched existing issues

  • I have provided clear steps or a clear description

  • I attached logs/screenshots if relevant

Other than those additions, Everything else is good and thanks again for the efforts!

@Bahati308
Copy link
Contributor Author

Thanks @Bahati308, these additions look really good and they match the Github standards. Perhaps what other mature projects include that we might add are:

  • Severity: critical, major, minor, low
  • Priority: P0–P3
    These help triage bugs quickly.

Maybe in addition to that:

  • You added additional context, but many teams make this explicit: They can upload images or videos showing the issue.
  • You included environment/version in Bug Report, but not for feature requests.
  • Another optional but Helpful one is to add a "Checklist Before Submitting" e.g
  • I have searched existing issues
  • I have provided clear steps or a clear description
  • I attached logs/screenshots if relevant

Other than those additions, Everything else is good and thanks again for the efforts!

thanks for the feedback @IamLRBA , though the points mentioned are catered for by the issue labels since some(especially new) contributors may not be in position to know the severity of the issues hence the maintainers can label the issue opened according to the severity.

@IamLRBA
Copy link
Contributor

IamLRBA commented Dec 2, 2025

Aaah that's right!
In that case, we can have this template merged so that we start to have our issues use the template right away.
Thanks @Bahati308

@Bahati308 Bahati308 merged commit b606c86 into OpenDataEnsemble:main Dec 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New functionality or capability

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants