Skip to main content
Version: 2.0.0-alpha.75

Contributing

Docusaurus 2 is currently under alpha development. We have early adopters who already started using it. We are now welcoming contributors to collaborate on the next Docusaurus.

The Open Source Guides website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:

Code of Conduct#

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Get involved#

There are many ways to contribute to Docusaurus, and many of them do not involve writing any code. Here's a few ideas to get started:

  • Start using Docusaurus 2! Go through the Getting Started guides. Does everything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
  • Look through the v2.0 issues. If you find an issue you would like to fix, open a pull request. Issues tagged as Good first issue are a good place to get started.
  • Help us making the docs better. File an issue if you find anything that is confusing or can be improved. We also have an umbrella issue for v2 docs where we are planning and working on all v2 docs. You may adopt a doc piece there to work on.
  • Take a look at the features requested by others in the community and consider opening a pull request if you see something you want to work on.

Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at @docusaurus and let us know you are looking for a bit of help.

Join our Discord channel#

To participate in Docusaurus 2 dev, join the #docusaurus-2-dev channel.

Our development process#

Docusaurus uses GitHub as its source of truth. The core team will be working directly there. All changes will be public from the beginning.

When a change made on GitHub is approved, it will be checked by our continuous integration system, CircleCI.

Reporting new issues#

When opening a new issue, always make sure to fill out the issue template. This step is very important! Not doing so may result in your issue not managed in a timely fashion. Don't take this personally if this happens, and feel free to open a new issue once you've gathered all the information required by the template.

  • One issue, one bug: Please report a single bug per issue.
  • Provide reproduction steps: List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.

Reporting bugs#

We use GitHub Issues for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you a are certain this is a new, unreported bug, you can submit a bug report.

If you have questions about using Docusaurus, contact the Docusaurus Twitter account at @docusaurus, and we will do our best to answer your questions.

You can also file issues as feature requests or enhancements. If you see anything you'd like to be implemented, create an issue with feature template

Reporting security bugs#

Facebook has a bounty program for the safe disclosure of security bugs. With that in mind, please do not file public issues; go through the process outlined on that page.

Working on Docusaurus code#

Installation#

  1. Ensure you have Yarn installed
  2. After cloning the repository, run yarn install in the root of the repository
  3. To start a local development server serving the Docusaurus docs, go into the website directory and run yarn start

Semantic commit messages#

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: allow overriding of webpack config^--^  ^------------^|     ||     +-> Summary in present tense.|+-------> Type: chore, docs, feat, fix, refactor, style, or test.

The various types of commits:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Use lower case not title case!

Code conventions#

Style guide#

Prettier will catch most styling issues that may exist in your code. You can check the status of your code styling by simply running npm run prettier.

However, there are still some styles that Prettier cannot pick up.

General#

  • Most important: Look around. Match the style you see used in the rest of the project. This includes formatting, naming files, naming things in code, naming things in documentation.
  • "Attractive"

Documentation#

  • Do not wrap lines at 80 characters - configure your editor to soft-wrap when editing documentation.

Pull requests#

Your first pull request#

So you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.

Working on your first Pull Request? You can learn how from this free video series:

How to Contribute to an Open Source Project on GitHub

We have a list of beginner friendly issues to help you get your feet wet in the Docusaurus codebase and familiar with our contribution process. This is a great place to get started.

Proposing a change#

If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also file an issue with feature template.

If you intend to change the public API (e.g., something in docusaurus.config.js), or make any non-trivial changes to the implementation, we recommend filing an issue with proposal template and including [Proposal] in the title. This lets us reach an agreement on your proposal before you put significant effort into it. These types of issues should be rare.

If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend to file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.

Sending a pull request#

Small pull requests are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it. It is recommended to follow this commit message style.

Please make sure the following is done when submitting a pull request:

  1. Fork the repository and create your branch from master.
  2. Add the copyright notice to the top of any code new files you've added.
  3. Describe your test plan in your pull request description. Make sure to test your changes!
  4. Make sure your code lints (yarn prettier && yarn lint).
  5. Make sure your Jest tests pass (yarn test).
  6. If you haven't already, sign the CLA.

All pull requests should be opened against the master branch.

Test plan#

A good test plan has the exact commands you ran and their output, provides screenshots or videos if the pull request changes UI.

  • If you've changed APIs, update the documentation.

Breaking changes#

When adding a new breaking change, follow this template in your pull request:

### New breaking change here
- **Who does this affect**:- **How to migrate**:- **Why make this breaking change**:- **Severity (number of people affected x effort)**:

Copyright header for source code#

Copy and paste this to the top of your new file(s):

/** * Copyright (c) Facebook, Inc. and its affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */

Contributor License Agreement (CLA)#

In order to accept your pull request, we need you to submit a CLA. You only need to do this once, so if you've done this for another Facebook open source project, you're good to go. If you are submitting a pull request for the first time, the Facebook GitHub Bot will reply with a link to the CLA form. You may also complete your CLA here.

What happens next?#

The core Docusaurus team will be monitoring for pull requests. Do help us by keeping pull requests consistent by following the guidelines above.

License#

By contributing to Docusaurus, you agree that your contributions will be licensed under its MIT license.