Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing.md Enhancement #1683

Open
wants to merge 15 commits into
base: gh-pages
Choose a base branch
from

Conversation

chrisdel101
Copy link
Contributor

@chrisdel101 chrisdel101 commented Nov 14, 2024

This is a redo of #1671 (which was bungled) and a realization of #1608.

This changes are all made to the CONTRIBUTING.md allowing this file to remain in the repo. This is then copied into the /resources/contributing.md page (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.yml myself. This needs to be run to ensure that the script is copied over properly, and for the site contributing page to get populated.

Copy link

netlify bot commented Nov 14, 2024

Deploy Preview for expressjscom-preview ready!

Name Link
🔨 Latest commit fdca623
🔍 Latest deploy log https://app.netlify.com/sites/expressjscom-preview/deploys/673c06027b51780008532198
😎 Deploy Preview https://deploy-preview-1683--expressjscom-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@chrisdel101 chrisdel101 marked this pull request as ready for review November 14, 2024 22:57
@chrisdel101 chrisdel101 changed the title Contributing Contributing.md Enhancement Nov 15, 2024
css/uz.css Outdated Show resolved Hide resolved
@bjohansebas
Copy link
Member

@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 chrisdel101 force-pushed the contributing branch 3 times, most recently from 4283961 to 44cb937 Compare November 17, 2024 17:20
@chrisdel101
Copy link
Contributor Author

@chrisdel101 let's try to only modify things related to contributing in this PR; I'll review this PR in detail over the weekend.

Done.

Please run the pipeline update-external-docs.yml to check it works.

Comment on lines +104 to +105
> [!IMPORTANT]
> We are currently working toward a more streamlined translations workflow. As long as this notice is posted, we will _not_ be accepting any translation submissions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Considering that this will be reflected on the website, I wonder how it will look there, since it hasn't appeared yet. Maybe you should run the script to preview it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Contributor Author

@chrisdel101 chrisdel101 Nov 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh your right.
I ran the script over and over on my account to test but it doesn't have the commit access to persist the file, so I must have missed this. Thanks!
Will figure out something here and get back. Would like to keep this styling for the GH side, but the website cannot be like this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to this in the website file in both sections it occurs. And checked the link at the top of the page that goes here still works.
Screenshot 2024-11-18 at 9 27 46 PM

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The work looks great

@bjohansebas bjohansebas requested a review from a team November 17, 2024 17:59
chrisdel101 pushed a commit to chrisdel101/expressjs.com that referenced this pull request Nov 18, 2024
@chrisdel101 chrisdel101 force-pushed the contributing branch 2 times, most recently from 7eeeb5a to c6af18e Compare November 19, 2024 02:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants