Contributing.md Enhancement #1683
Conversation
✅ Deploy Preview for expressjscom-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
chrisdel101
requested review from
wesleytodd,
crandmck,
bjohansebas and
a team
|
@chrisdel101 let's try to only modify things related to contributing in this PR; I'll review this PR in detail over the weekend. |
chrisdel101
force-pushed
the
contributing
branch
3 times, most recently
from
4283961 to
44cb937
Compare
Done. Please run the pipeline |
- apply all branch changes
changes to soften workflow language
Add gh important tags to top of page
There was a problem hiding this comment.
@bjohansebas Were these (files are now missing- I'm referring to the commits ci: update...) part of this PR? I just reversed them since I thought they were mistakes, then looked again.
I guess you made these on this branch right?
I'll add them back (remove last two commits) in this was your intention.
EDIT: I added these back in.
EDIT2: Removing them was correct, so they are removed again.
chrisdel101
force-pushed
the
contributing
branch
2 times, most recently
from
c6c6266 to
e2f0788
Compare
|
btw, it's not necessary to run the workflow, running the script and making the commit in this PR is fine. The workflow is just a step to keep the rest of the documentation up to date. |
chrisdel101
force-pushed
the
contributing
branch
from
e2f0788 to
32196f9
Compare
|
@crandmck @wesleytodd @UlisesGascon Sebastian helped with all the technical stuff but could one of you read over the text content and let me know if you want any changes? |
- remove over use of important
- remove uz.css as it came back
- removing CI commits
- add HR line
-Add GH NOTE tag and filter out
chrisdel101
force-pushed
the
contributing
branch
from
f72825b to
720563a
Compare
You mean the CI? How do I stop it from running? I ran the workflow action outisde this repo to make sure the script paths didn't fail, if this is what you meant. |
This comment explains it quite well (#1553 (comment)) |
|
I commented inline, but we should be sure to clarify that no approval is necessary (i.e. in an issue) to start a PR. IMO an initial discussion issue is strongly recommended for very large contributions, just to ensure they make sense. The linked discussions came about because of very large refactoring PRs that had no previous discussion at all. While such PRs are not "prohibited", they can often lead to wasted time not only for the contributor but for the TC/approvers. External contributors may not always be aware of ongoing discussions or work and can open PRs that don't align with that and are very unlikely to land. Such PRs are certainly not prohibited, but are not a good use of anyone's time. |
- remove all "approval" language - add optional wording - make everything Express JS wording - remove italics as it not required - remove TLDR
Small typo fixes
|
cc: @expressjs/express-tc @expressjs/docs-wg |
There was a problem hiding this comment.
Awesome! I like the new way we are phrasing the discussion step. This looks great, thanks for the hard work @chrisdel101 and dealing with our "nitpicks" 🤣
|
i know this review might have taken extra work to get it sounding right so my thanks to everyone for helping to review this one. |
|
Maybe I'll have to wait for @crandmck approval, since it won't let me merge until the required changes review is removed. |
This is a redo of #1671 (which was bungled) and a realization of #1608.
This changes are all made to the
CONTRIBUTING.mdallowing this file to remain in the repo. This is then copied into the/resources/contributing.mdpage (at the bottom).All the text content here is fair game for edits, so if any language is unsuitable, something is incorrect, or you just don't like something it can be changed or removed.
The idea here was just to give a more detailed outline of how to contribute, so if the workflow for that is wrong, it can be corrected.
I left the translation sections in, but with notices of suspension.
Also looks like I cannot run the
update-external-docs.ymlmyself. This needs to be run to ensure that the script is copied over properly, and for the site contributing page to get populated.