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

Add "Contributing" to the navigation bar? #7237

Open
joyeecheung opened this issue Nov 18, 2024 · 11 comments · May be fixed by #7274
Open

Add "Contributing" to the navigation bar? #7237

joyeecheung opened this issue Nov 18, 2024 · 11 comments · May be fixed by #7274
Labels
enhancement feature-request Requesting a new Technological Feature to be added to the Website

Comments

@joyeecheung
Copy link
Member

Enter your suggestions in details:

This came from a Bluesky thread and somehow we went a bit off-topic to discuss about how to find the useful information about contributing to the project https://bsky.app/profile/patak.dev/post/3lbash7plsk2q

Currently, there is a page on the website about contributing but it's a bit hidden: in About -> Contribute to Node.js: https://nodejs.org/en/about/get-involved/contribute

Considering the project has always been very understaffed, I think it would be overall better for the project if we can have a more prominent place for the information about contribution on the website, say putting it in the navigation bar.

@RedYetiDev RedYetiDev added enhancement good first issue Issues for newcomers feature-request Requesting a new Technological Feature to be added to the Website labels Nov 18, 2024
@AugustinMauroy AugustinMauroy removed the good first issue Issues for newcomers label Nov 19, 2024
@AugustinMauroy
Copy link
Member

@RedYetiDev we put the good first issue to issue with consensus. Also when labeling that please add a "tuto" to how to fix the issue. So that allow the new comer to know what they can do

@AugustinMauroy
Copy link
Member

I'm -1 for that
If we do what Joyee is proposing, we'll find ourselves in the same ‘support version’ situation. Basically, the problem is that ‘support version’ and ‘contribute’ are sub-sections and so if you put them in the navbar there will be two entries that could be active, which is strange for a user. And in the other case, if we take the general section, there will be one entry that will never be active, which means that the user won't get any feedback on his action.

@joyeecheung
Copy link
Member Author

The idea is more about promoting a page with information about how to contribute. If being in a subsection gets in the way, maybe we could just move it out to be its own page?

@joyeecheung
Copy link
Member Author

joyeecheung commented Nov 19, 2024

Or, it does not need to be a page on the website, since the website page is mostly copying from other documents and could get out of sync over time. We can link the nav bar item to https://github.com/nodejs/node/blob/main/CONTRIBUTING.md directly as well. If that document is missing information, we can easily add more information there, and benefit those who look at that document too.

@AugustinMauroy
Copy link
Member

The idea is more about promoting a page with information about how to contribute. If being in a subsection gets in the way, maybe we could just move it out to be its own page?

I'm in favour of having more documents to contribute to the project. Just putting it in the navBar is -1

@AugustinMauroy
Copy link
Member

https://github.com/nodejs/node/blob/main/CONTRIBUTING.md directly as well. If that document is missing information, we can easily add more information there, and benefit those who look at that document too.

We could see a sub-section called ‘Contribute to the project’, which would be a collection of links (to GH) that would allow each team/working group to highlight their own contributions. So each WG/team needs to have a document that does a proper onboarding.

@joyeecheung
Copy link
Member Author

I think the subsection idea doesn't address the issue about information about contribution being hidden. For example, the nav bar currently links to https://training.linuxfoundation.org/openjs/ too - is that information more important to the project than recruiting more contributors, though?

@ovflowd
Copy link
Member

ovflowd commented Nov 20, 2024

Many prominent open source projects have Contributed or Donated on their main navigation bars.

Strong +1; I'm usually against adding extra links up there, but this one makes sense, and it could still go to our page which is an abridged version of the CONTRIBUTING.md

@AugustinMauroy
Copy link
Member

AugustinMauroy commented Nov 21, 2024

I was wondering if the contributing page (the one on the site) shouldn't just be a series of ordered links to understand how node-core works.

"though they are usually not properly linked or listed, which was why I opened" Joyee

@joyeecheung
Copy link
Member Author

I think it would be better for the contribution info on the website to redirect to links in the core repo (at least, when we are talking about contributing to core), otherwise it risks getting out of date again - even in the core repo, documentation gets out of date all the time, but on the website it would be even worse, for example when someone update a file name, at least find-and-replace in the repository helps you update the document as well. But if it's in a separate repository, it will probably only get noticed after years. I think every time I check out the website about this kind of information, it's never not outdated. e.g. #7238 and #6604

@bmuenzenmeyer
Copy link
Collaborator

bmuenzenmeyer commented Nov 22, 2024

👍 for adding a more prominent link to https://github.com/nodejs/node/blob/main/CONTRIBUTING.md

I've created #7274 to show what that would look like.

@bmuenzenmeyer bmuenzenmeyer linked a pull request Nov 22, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement feature-request Requesting a new Technological Feature to be added to the Website
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants