Skip to content

Conversation

lchans
Copy link
Collaborator

@lchans lchans commented Apr 23, 2025

External Links

Description

  • Beefs up the README a little bit
  • Adds CONTRIBUTING.md

@lchans lchans changed the title chore/MIG-6658 Update README chore/MIG-6658 Add README.md and CONTRIBUTING.md May 22, 2025
@lchans lchans requested review from sahildmk and marian-derias May 22, 2025 03:33
@lchans lchans marked this pull request as ready for review May 22, 2025 03:33
Copy link
Collaborator

@marian-derias marian-derias left a 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?

@lchans
Copy link
Collaborator Author

lchans commented May 22, 2025

Thanks @marian-derias, addressed those comments in c751a1e

Copy link
Collaborator

@sahildmk sahildmk left a 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>
Copy link
Collaborator

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.

Copy link
Collaborator Author

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

@lchans lchans merged commit cc22a17 into main May 26, 2025
1 check passed
@lchans lchans deleted the chore/MIG-6658-update-readme branch May 26, 2025 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants