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
|
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. |
There was a problem hiding this comment.
The content looks good. My comments are mostly copy-edits. While these aren't critical, since this page is specifically about doc contributions, it should be reasonably exemplary.
I made a number of inline comments. Also, all the headings need to be revised to be in sentence case, per the documentation style guide.
CONTRIBUTING.md
Outdated
| 1. **Website Related**: | ||
| If you see anything on the site that could use a tune-up, think about how to fix it. | ||
|
|
||
| - display or screen sizing problems |
There was a problem hiding this comment.
Begin bullet-list items with a capital letter.
- make additional copy edits found during edit
|
Hi @crandmck. I made all the changes and actually removed quite a bit of other superfluous language. Can you please review again? |
|
The script works fine locally, and I don't see anything unusual. Once this is merged, I will run the script on GitHub. |
chrisdel101
force-pushed
the
contributing
branch
2 times, most recently
from
67871a5 to
dcc7c8f
Compare
|
So I keep getting unwanted changes in my commits. It happens when I merge I think. This has happened again here and it has ruined my commit history. I don't see anyone else complaining about this so not sure why it happens to me so much but it's happened again here. Anyway, the script isn't working correctly now which I'll need to fix. Might be a result of the The copy is hopefully still okay and can still be reviewed in the meantime. |
|
I think it was a good idea to enable them to update their branch from the GitHub interface. @chrisdel101 I believe I can fix your history now since I have the necessary permissions to do so. |
bjohansebas
force-pushed
the
contributing
branch
from
dcc7c8f to
4531876
Compare
bjohansebas
force-pushed
the
contributing
branch
from
4531876 to
6754436
Compare
|
@chrisdel101 I think everything is good now, right? |
Yes it looks okay. Thanks for fixing that, however you did it! I've been pulling into my local branch but this has consistently led to problems. What's the best way to merge? |
@chrisdel101 No, you always have to wait until there are no required changes (especially when it's a team member) and I have approval from someone with write permissions (in some cases, it will be necessary for a TC member to approve it as well). If you want, you can contact @crandmck on Slack to get his approval if he wants. Once there are no more required changes and we all agree, you can merge this. |
- remove {{content}} as it renders in liquid
|
Alrighty I fixed the script file and it's working as expected. I tested it on my action and it ran. It didn't like the lines like these |
Co-authored-by: Chris Del <[email protected]> Co-authored-by: chris del <[email protected]> Co-authored-by: Sebastian Beltran <[email protected]> Co-authored-by: Rand McKinney <[email protected]>
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.