- Quick Start
- Code of Conduct
- Ways to Contribute
- Development Workflow
- Documentation Structure
- Getting Help
- Project Maintainers
- License
Thank you for your interest in contributing to the Node.js Website! This guide will help you get started with contributing to our project.
New to contributing? Start here:
- Getting Started - Set up your development environment and make your first contribution
- Code Style - Learn our coding standards and formatting guidelines
- Adding Pages - Create new pages and content for the website
Before contributing, please read and follow our Code of Conduct.
By contributing to this project, I certify that:
- (a) The contribution was created in whole or in part by me and I have the right to
submit it under the open source license indicated in the file; or
- (b) The contribution is based upon previous work that, to the best of my knowledge,
is covered under an appropriate open source license and I have the right under that
license to submit that work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am permitted to submit under a
different license), as indicated in the file; or
- (c) The contribution was provided directly to me by some other person who certified
(a), (b) or (c) and I have not modified it.
- (d) I understand and agree that this project and the contribution are public and that
a record of the contribution (including all personal information I submit with it,
including my sign-off) is maintained indefinitely and may be redistributed consistent
with this project or the open source license(s) involved.
- Report Issues: Found a bug or have a feature request? Open an issue
- Improve Documentation: Help make our docs clearer and more comprehensive
- Add Content: Create new learn articles, blog posts, or improve existing content
- Fix Bugs: Look for issues labeled
good first issue - Translate Content: Help make Node.js documentation accessible worldwide
- Create Components: Build reusable React components following our component guidelines
- Write Tests: Improve test coverage with our testing guidelines
- Enhance Features: Add new functionality to improve user experience
# Fork and clone the repository
git clone https://github.com/YOUR_USERNAME/nodejs.org.git
cd nodejs.org
# Install dependencies
pnpm install --frozen-lockfile
# Start development server
node --run devFor detailed setup instructions, see Getting Started.
- New Pages: Follow our page creation guide
- Components: See creating components
- Styling: Follow our code style guidelines
# Format and lint code
node --run format
# Run tests
node --run test
# Test build
node --run build- Create a branch:
git checkout -b your-feature-branch - Commit changes: Follow our commit guidelines
- Push to your fork:
git push origin your-feature-branch - Open a Pull Request: Use our pull request template
Our documentation is organized in the docs/ directory, so check out it's README for navigation.
- Questions? Start a Discussion
- Found a bug? Open an issue
- Need clarification? Comment on existing issues or PRs
- Want to chat? Join the Node.js community on OpenJS Foundation Slack
This project is maintained by the Node.js Website Team. For questions about governance or high-level project direction, you can:
- Mention
@nodejs/nodejs-websitein issues or PRs - Contact team members directly for guidance
- Escalate to the Node.js Technical Steering Committee if needed
By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.
Ready to contribute? Start with our Getting Started guide and join the Node.js community in building better web experiences for developers worldwide! 🚀