Skip to content

docs(pull_request_template): add merging guidelines #55

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.

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

Merged
merged 3 commits into from
Jan 14, 2021

Conversation

rubinovitz
Copy link
Contributor

PR Description

PR Checklist

Testing

  • added relevant test coverage
  • no tests needed

Docs

  • added relevant docs
  • updated relevant sections in the README.md
  • updated relevant docstrings in index.d.ts
  • no docs needed

Typescript

  • added or edited relevant Typescript type declarations
  • no type declaration updates needed

@rubinovitz rubinovitz requested a review from crs48 January 11, 2021 23:11

To merge, select "Squash and Merge". Then:
1. Make sure the top commit message follows [Angular Git Commit Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines),
2. Delete all other commit messages, but keep any lines designating [co-authors](https://docs.github.com/en/free-pro-team@latest/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors) so contributors will retain credit for their contributions.
Copy link
Member

Choose a reason for hiding this comment

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

I think we should say something along the lines of this for step 2.

  1. Clean up the description, make sure to keep any lines designating [co-authors] ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@smothers my problem with this is that I don't think it's obvious the commit messages are the "description" when it's filled with commit messages and you can't see the "description" place holder.

Maybe "Delete all other commit messages in the description, but keep any lines designating co-authors so contributors will retain credit for their contributions." ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

resolved in latest

crs48
crs48 previously approved these changes Jan 12, 2021
@rubinovitz rubinovitz merged commit 3e69c05 into master Jan 14, 2021
@rubinovitz rubinovitz deleted the merging-guidelines-docs branch January 14, 2021 17:30
@github-actions
Copy link

github-actions bot commented Feb 1, 2021

🎉 This PR is included in version 0.5.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

2 participants