Skip to content

Include additional PR guidelines - #911

Open
voetberg wants to merge 1 commit into
rucio:mainfrom
voetberg:contrib-update
Open

voetberg wants to merge 1 commit into
rucio:mainfrom
voetberg:contrib-update

Conversation

@voetberg

Copy link
Copy Markdown
Contributor

These are things I'm always pointing out to new contributors, maybe it's not clear in the contributing guide.

  • Split PR into commits by type
  • Include an AI disclosure

Comment thread docs/contributing.md
Comment on lines +117 to +118
For example, if a refactor is used to improve the quality of a feature, a commit with the `refactor`
isolated should included alongside the `feat` commit.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Wording here seems a bit off to me, maybe this improves it

Suggested change
For example, if a refactor is used to improve the quality of a feature, a commit with the `refactor`
isolated should included alongside the `feat` commit.
For example, if a refactor is used to improve the quality of a feature, a commit with the `refactor`
isolated should be included alongside the `feat` commit.

but also '...a commit with the refactorisolated' could be improved imo

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah I workshopped this a few different ways and I couldn't settle on anything better. Back to the drawing board!

This branch has not been deployed

No deployments
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.

2 participants