Skip to content
This repository has been archived by the owner on May 3, 2021. It is now read-only.

Reformat the Template #16

Open
flixx opened this issue May 4, 2018 · 2 comments
Open

Reformat the Template #16

flixx opened this issue May 4, 2018 · 2 comments

Comments

@flixx
Copy link
Member

flixx commented May 4, 2018

The template is not optimal yet, because it contains a lot of unnecessary information and does not give space to define important information.

Suggestions:

  • Include the type(s) of the PR in the title
  • Don't list all the non-applying items. All the options that are not ticked are just wasting space in the PR.
  • Rename "Other information" to "Description" and move it to the top of the template. A free-description is the most important thing for me when I write PRs.
  • Give the possibility to define custom options under "Review and Merge". E.g. "Merge after PO approves"
@flixx
Copy link
Member Author

flixx commented May 4, 2018

Example:

image

The most important information here is at the bottom.

Better would be:

Refactor[B3-3867] - Refactor of project comments api

This is more or less just moving files around, so we won't have big bloated views with multiple views inside, the same is applied here to serializers.

Testing procedure

Case 1

  1. Just test the commenting system in yoda

Case 2

  1. You can also just run the tests

Does this PR introduce a breaking change?
no

Review and Merge
Last approver merges after > 51% of the reviewers approved

Changelog
Note
• refactoring of project comments API structure to match standards, closes #3867

@igeligel
Copy link
Collaborator

igeligel commented May 4, 2018

Normally the best case is that we just copy the description out of JIRA issue in the pull request. For now, we can add a description field and replace Other Information with that.

I would prioritize the topics like this:

  1. Title
  2. Description
  3. Type
  4. Breaking
  5. Testing Procedure
  6. (Other information)
  7. Merger
  8. Changelog

I guess i can also use some kind of analytics system to see what of the features are the most used and put them to the beginning since these are the most important then.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants