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.

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

Add ELN contributor guidelines #50

Open
JanCBrammer opened this issue Nov 16, 2021 · 0 comments
Open

Add ELN contributor guidelines #50

JanCBrammer opened this issue Nov 16, 2021 · 0 comments
Assignees

Comments

@JanCBrammer
Copy link
Collaborator

JanCBrammer commented Nov 16, 2021

Suggestions so far:

  • commit title is meaningful => git history search
  • commit description is helpful => helps the reviewer to understand the changes
  • code is up-to-date with the latest developments of the target branch (rebased to it or whatever) => ⏩ :-merge for linear history is favored
  • added code is linted
  • tests are passing (at least locally)
  • if the changes are visible to the end-user, video or screenshots should be added to the PR => helps with user testing
  • testing coverage improvement is more than welcome
  • CHANGELOG : add a bullet point on top (optional: reference to github issue/PR )
  • clarify which dependencies are added, if any
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant