Add GOALS.md, revise contribution process, freshen up to use arewesafetycriticalyet.org #149
Conversation
✅ Deploy Preview for scrc-coding-guidelines ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
PLeVasseur
force-pushed
the
feature/coding-guidelines-goals
branch
from
99c4170 to
863169b
Compare
|
@PLeVasseur do you want me to take a look at this? :) |
|
That'd be very kind of you ;D |
felix91gr
left a comment
felix91gr
left a comment
There was a problem hiding this comment.
I hope you're ready for many comments <3
felix91gr
left a comment
felix91gr
left a comment
There was a problem hiding this comment.
Suggestions are now in place ^^
PLeVasseur
force-pushed
the
feature/coding-guidelines-goals
branch
5 times, most recently
from
494cbda to
ff367d1
Compare
PLeVasseur
changed the title
felix91gr
left a comment
felix91gr
left a comment
There was a problem hiding this comment.
Long diffs. My bad.
Also I really like how the Contributing document is shaping up!
I hope my suggestions make sense x3
|
Reminder to self to put somewhere that the current only way to retrigger the Netlify action is to submit an empty commit.
Should find an alternative way to trigger via GitHub if possible |
PLeVasseur
force-pushed
the
feature/coding-guidelines-goals
branch
from
25cae3b to
12fef6d
Compare
felix91gr
left a comment
felix91gr
left a comment
There was a problem hiding this comment.
I think this is the only part that still feels weird to me. The other changes were amazing; you went above and beyond and now they are super clear to read <3
Co-authored-by: Félix Fischer <felix91gr@users.noreply.github.com>
Co-authored-by: Félix Fischer <felix91gr@users.noreply.github.com>
Co-authored-by: Félix Fischer <felix91gr@users.noreply.github.com>
Co-authored-by: Félix Fischer <felix91gr@users.noreply.github.com>
Co-authored-by: Félix Fischer <felix91gr@users.noreply.github.com>
Co-authored-by: Félix Fischer <felix91gr@users.noreply.github.com>
Co-authored-by: Sam <samuel@plaindocs.com>
Co-authored-by: Sam <samuel@plaindocs.com>
Co-authored-by: Sam <samuel@plaindocs.com>
Co-authored-by: Sam <samuel@plaindocs.com>
Co-authored-by: Sam <samuel@plaindocs.com>
PLeVasseur
force-pushed
the
feature/coding-guidelines-goals
branch
from
a96cba2 to
fbd3119
Compare
|
If you want to get this merged, I'm happy to keep talking about the workflow and other issues in a new issue / PR. |
| - [Table of Contents](#table-of-contents) | ||
| - [Contribution Workflow](#contribution-workflow) | ||
| - [Note on Chapter Layout](#note-on-chapter-layout) | ||
| - [0) Bring up the idea for discussion](#0-bring-up-the-idea-for-discussion) |
There was a problem hiding this comment.
Might be helpful to also include the "optional" marker here. Can be done in a follow-up.
|
|
||
| ### 3) A Pull Request is generated | ||
|
|
||
| Once an issue has been well-developed enough, a subcommittee member will mark the issue with the label `sign-off: create pr from issue` to generate a pull request. You will see a GitHub Workflow trigger and a pull request will be automatically created. |
There was a problem hiding this comment.
We might want to add some points in the future what "well-developed" means.
| #### 4.1) Apply changes to the Guideline's Issue | ||
|
|
||
| If you agree with the suggested changes, then rather than making changes on the opened pull request, you will return to the original issue you opened via the coding guideline issue template, and make the updates there. | ||
|
|
||
| #### 4.2) Re-generate the Pull Request | ||
|
|
||
| When you have completed all feedback given to you, ping one of the subcommittee members. They will then remove and affix the label `sign-off: create pr from issue` to push the changes made in the issue to the already opened pull request. |
There was a problem hiding this comment.
I think once the issue has been converted to a PR, there's no looking back. We should then continue working on the PR and maybe even close the issue (not sure on that one, though).
darkwisebear
left a comment
darkwisebear
left a comment
There was a problem hiding this comment.
Considering what we've discussed in yesterday's meeting: I think there are no blocking issues anymore, and while there may be points where we do not agree 100%, I am in favor of merging this as-is, opening up follow-up PRs (or issues, if needed) for these points.
| ## Table of Contents | ||
|
|
||
| - [Contributing to the coding guidelines](#contributing-to-the-coding-guidelines) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Contribution Workflow](#contribution-workflow) |
There was a problem hiding this comment.
I think GH handles TOC automatically now in the README, so I think we can delete this whole section and the maintenance burden?
From main:
|
We said 48 hours in the meeting, so based on the discussion above, I would like to merge this and defer any outstanding changes to the details of workflow etc. to a new PR. Blocking objections? Otherwise, |
FYI to @felix91gr -- you'll need to approve the PR, otherwise it won't go on the merge queue. This is because you've previously marked the PR as requiring changes, see screenshot: |
felix91gr
left a comment
felix91gr
left a comment
There was a problem hiding this comment.
(Whoops, forgot I was blocking this!)
We ship and address future needs later :3
|
CC @PLeVasseur |
6 participants
Closes #145