Node.js Website Contributing Guide

Quick Start

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

Code of Conduct

Before contributing, please read and follow our Code of Conduct.

Developer's Certificate of Origin 1.1

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.

Ways to Contribute

For All Contributors

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

For Developers

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

Development Workflow

1. Set Up Your Environment

# 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 dev

For detailed setup instructions, see Getting Started.

2. Make Your Changes

New Pages: Follow our page creation guide
Components: See creating components
Styling: Follow our code style guidelines

3. Test Your Changes

# Format and lint code
node --run format

# Run tests
node --run test

# Test build
node --run build

4. Submit Your Contribution

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

Documentation Structure

Our documentation is organized in the docs/ directory, so check out it's README for navigation.

Getting Help

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

Project Maintainers

This project is maintained by the Node.js Website Team. For questions about governance or high-level project direction, you can:

Mention @nodejs/nodejs-website in issues or PRs
Contact team members directly for guidance
Escalate to the Node.js Technical Steering Committee if needed

License

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! 🚀

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!