Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create pull request template #205

Closed
tatiana opened this issue Mar 13, 2022 · 3 comments · Fixed by #479
Closed

Create pull request template #205

tatiana opened this issue Mar 13, 2022 · 3 comments · Fixed by #479
Assignees
@dimberman
Labels
documentation Improvements or additions to documentation

Comments

@tatiana
Copy link
Collaborator

tatiana commented Mar 13, 2022

Context
At the moment the project doesn't have a PR template.

Some examples of PR templates can be seen:
https://github.com/devspace/awesome-github-templates#rocket-templates-for-pull-requests

Acceptance criteria

  • Create .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@tatiana tatiana added the documentation Improvements or additions to documentation label Mar 14, 2022
@bhavaniravi
Copy link
Contributor

What are the things we want our contributors to keep in mind when raising PR?

Few mandatory items I can think of to be added in every PR

Fixes #issue-ref

Description/Approach

??

@tatiana
Copy link
Collaborator Author

tatiana commented Mar 16, 2022 •
edited
Loading

@bhavaniravi those are must have, absolutely!

At the moment we have a checklist for new features issues. I believe we should have a similar list for pull requests. Not all pull requests will need all the items of the checklist, but they could serve as reminders

@kaxil
Copy link
Collaborator

kaxil commented Jun 10, 2022

In my opinion, some of the things that we should have:

  • Any assumptions made when implementing the code in the PR
  • Limitations
  • A description of the changes proposed in the pull request. A PR reviewer should know on a high-level (the approach) on what the changes in the PR achieves
  • A reference to a related issue in your repository.
  • If there are any new tickets or action items we need to do even after merging the PR. (Code, docs etc)
  • If there are interface or breaking changes: would be good to see a before/after example or screenshot if not already discussed or included in the issue.
  • Any open questions you have which you want the reviewer to give their opinion on.

Only the ones that are applicable for a particular PR should be added.

Some Examples of PRs with good descriptions:

@dimberman dimberman mentioned this issue Jun 21, 2022
Merged
2 tasks
dimberman added a commit that referenced this issue Jun 22, 2022
@dimberman
Create Pull Request template (#479)
54073fd 
# Description
## What is the current behavior?
Currently there is no pull request template so users need to create their own PR descriptions from scratch. This leads to under-descriptive PRs and a lack of consistency.

<!-- Issues are required for both bug fixes and features. -->
closes:  #205
related:


## What is the new behavior?

Now when users create a PR, they will get this description automatically to help them fill in relevant details

## Does this introduce a breaking change? No

<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->


### Checklist
- [x] Created tests which fail without the change (if possible)
- [x] Extended the README / documentation, if necessary

closes #205
@dimberman dimberman mentioned this issue Jun 23, 2022
Merged
kaxil pushed a commit that referenced this issue Jun 23, 2022
@dimberman
Create a default pull request template (#486)
73a05b4 
related: #205
utkarsharma2 pushed a commit that referenced this issue Jun 24, 2022
@dimberman @utkarsharma2
Create a default pull request template (#486)
1c33d51 
related: #205
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dimberman dimberman

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create Pull Request template astronomer/astro-sdk
4 participants
@tatiana @dimberman @kaxil @bhavaniravi