-
Notifications
You must be signed in to change notification settings - Fork 1
chore/MIG-6658 Add README.md and CONTRIBUTING.md #29
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It reads really well, thank you! np: could we have another section in the CONTRIBUTING.md file about linting?
Thanks @marian-derias, addressed those comments in c751a1e |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just a few small comments!
Write commit messages that are straightforward, clear, and describe a single purpose. Similar to pull request naming, the format is something like the following: | ||
|
||
``` | ||
<type>/<ticket-ID> <short description> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do commit messages also need a type
and ticket-ID
? I guess this depends on the PR merge policy. If we do squash and merge, I don't think this is required, but if we're not squashing then this makes sense to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Haven't decided on the merge policy yet, but I'll keep this in here for now
External Links
Description