Skip to content
This repository has been archived by the owner on Sep 14, 2020. It is now read-only.

Improve the GitHub issues/prs templates #278

Merged
merged 3 commits into from
Jan 3, 2020

Conversation

nolar
Copy link
Contributor

@nolar nolar commented Dec 23, 2019

What do these changes do?

Based on the experience of the past 9 months, improve the issue/pr templates by adding the guiding questions and the structure (e.g. in the Bug Reports).

Description

The original templates were taken from the Zalando's template repo and did not use the GitHub's new features.

Now, the new GitHub features will be used:

  • Multiple templates for issues: Bug Report, Feature Request, Question, and Security Report.
  • The Bug Report contains placeholders for a code snippet and log output, formatted to fold/unfold the long sections.
  • All the templates contain the guiding questions for the reporter, to make the issues more complete and detailed. (As comments, so they are visible in the form, but not rendered in the resulting issue/pr.)

The code is not affected in any way. Just the GitHub interaction.

Issues/PRs

Issues: #12 #3

Type of changes

  • Mostly CI/CD automation, contribution experience

Checklist

  • The code addresses only the mentioned problem, and this problem only
  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt

@nolar nolar added the automation CI/CD: testing, linting, releasing automatically label Dec 23, 2019
@nolar nolar requested a review from perploug December 23, 2019 16:24
@nolar nolar requested a review from samurang87 as a code owner December 23, 2019 16:24
@zincr
Copy link

zincr bot commented Dec 23, 2019

🤖 zincr found 0 problems , 0 warnings

✅ Large Commits
✅ Approvals
✅ Specification
✅ Dependency Licensing

@zincr
Copy link

zincr bot commented Dec 23, 2019

🤖 zincr found 1 problem , 0 warnings

❌ Approvals
✅ Large Commits
✅ Specification
✅ Dependency Licensing

Details on how to resolve are provided below


Approvals

All proposed changes must be reviewed by project maintainers before they can be merged

Not enough people have approved this pull request - please ensure that 1 additional user, who have not contributed to this pull request approve the changes.

  • ✅ Approved by PR author @nolar
  • ❌ 1 additional approval needed
     

@nolar nolar requested a review from aweller January 3, 2020 12:11
@nolar nolar merged commit 741942f into zalando-incubator:master Jan 3, 2020
@nolar nolar deleted the 12-better-templates branch January 3, 2020 12:25
- [ ] I think the code is well written
- [ ] Unit tests for the changes exist
- [ ] Documentation reflects the changes
- [ ] If you provide code modification, please add yourself to `CONTRIBUTORS.txt`

Choose a reason for hiding this comment

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

"modifications"


## Checklist

- [ ] The code addresses only the mentioned problem, and this problem only

Choose a reason for hiding this comment

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

I could use this line for myself lol

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
automation CI/CD: testing, linting, releasing automatically
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants