Asking new contributors to assign reviewers, which is not possible #73
Assignees
Labels
question
Further information is requested
Comments
|
True. I agree to change the template and add smth like "if you have at least write-access". The admins should then make sure to receive notifcations about new PRs, otherwise they might be unnoticed. |
Merged
20 tasks
joeloskarsson
added a commit
that referenced
this issue
Sep 10, 2024
## Describe your changes As a new contributor you can not actually assign reviewers and asignees to PRs. But we request this in the PR template: https://github.com/mllam/neural-lam/blob/4969f92ad974f136089d15e7e2e2e9d73a43590d/.github/pull_request_template.md?plain=1#L29 This change clarifies the PR template to state that you only have to do this if you are able to. Otherwise we instruct contributors to tag a maintainer to add reviewer and asignee. ## Issue Link Solves #73 ## Type of change - [ ] 🐛 Bug fix (non-breaking change that fixes an issue) - [ ] ✨ New feature (non-breaking change that adds functionality) - [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 📖 Documentation (Addition or improvements to documentation) ## Checklist before requesting a review - [x] My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use `pull` with `--rebase` option if possible). - [x] I have performed a self-review of my code - [x] For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values - [x] I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code - [x] I have updated the [README](README.MD) to cover introduced code changes - [x] I have added tests that prove my fix is effective or that my feature works - [x] I have given the PR a name that clearly describes the change, written in imperative form ([context](https://www.gitkraken.com/learn/git/best-practices/git-commit-message#using-imperative-verb-form)). - [x] I have requested a reviewer and an assignee (assignee is responsible for merging) ## Checklist for reviewers Each PR comes with its own improvements and flaws. The reviewer should check the following: - [ ] the code is readable - [ ] the code is well tested - [ ] the code is documented (including return types and parameters) - [ ] the code is easy to maintain ## Author checklist after completed review - [x] I have added a line to the CHANGELOG describing this change, in a section reflecting type of change (add section where missing): - *added*: when you have added new functionality - *changed*: when default behaviour of the code has been changed - *fixes*: when your contribution fixes a bug ## Checklist for assignee - [x] PR is up to date with the base branch - [x] the tests pass - [x] author has added an entry to the changelog (and designated the change as *added*, *changed* or *fixed*) - Once the PR is ready to be merged, squash commits and merge the PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When setting up #72 @ErikLarssonDev noticed that as a new contributor you can not actually assign reviewers and asignees to PRs. But we request this in the PR template:
neural-lam/.github/pull_request_template.md
Line 29 in 4969f92
Reading https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review it indeed seems to be the case that only users with write access to the repo can actually assign reviewers to their PR.
What we now have in the PR template then seems contradictory, and we probably don't want to keep giving write access to anyone who want to contribute. Should we just clarify the PR template that this only applies if you can, or what's your thoughts @leifdenby @sadamov ?
The text was updated successfully, but these errors were encountered: