Remove the broken badge, add coding guidelines and simplify PR/issue templates #86
Conversation
Two GitHub actions (build and type checking) were combined into one, so only one badge is needed.
vedran-kasalica
changed the title
vedran-kasalica
changed the title
|
I am done making changes, the PR can be reviewed. They reflect some of our discussions today (offline within the rest of the team) about the coding standards and guidelines. |
| --- | ||
| name: Bug report | ||
| about: Create a report to help us improve | ||
| title: '' | ||
| labels: bug | ||
| assignees: '' | ||
|
|
||
| --- |
There was a problem hiding this comment.
What is the reason you suggest to have this table at the top of the issue/PR? It confuses me a little, in particular because the "about" is also clarified at "bug details", "name" is similar to "labels", and "assignees" is usually chosen manually. What am I missing here?
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| ## Type of change | ||
|
|
||
| Please delete options that are not relevant. |
There was a problem hiding this comment.
| Please delete options that are not relevant. | |
| Please select relevant options (can be multiple). |
There was a problem hiding this comment.
Since you suggest working with checkboxes here, perhaps simply (un)checking is sufficient.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| ## Checklist before requesting a review | ||
|
|
||
| - [ ] I have read the [contribution guidelines](https://github.com/biomarkersParkinson/tsdf/blob/main/CONTRIBUTING.md) | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas |
There was a problem hiding this comment.
| - [ ] I have commented my code, particularly in hard-to-understand areas | |
| - [ ] I have documented my code, particularly in hard-to-understand areas |
There was a problem hiding this comment.
Not sure, but perhaps this is more appropriate phrasing.
.github/pull_request_template.md
Outdated
|
|
||
| ## Related Issue(s) | ||
| <!-- List related issues or tasks that this pull request addresses. Use the format `#issue_number` to automatically link them here. --> | ||
| Please delete options that are not relevant. |
There was a problem hiding this comment.
Similar changes as in prior suggestion if agreed upon.
|
Hi @Erikpostt somehow I didn't get the notifications for your comments (maybe because I was not tagged), otherwise I would have replied of course. I got one now that it was merged. Thanks for resolving it! |
Two GitHub actions (build and type checking) were combined into one, so only one badge is needed.
The templates for the PR and Issues were simplified.
Contributing.mdwas updated to include coding guidelines (python code, docstrings, testing, etc.).