Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 1.58 KB
Raw

Contributing to Next.js Docs Generator

Contributions are always welcome. Read these steps to learn how to contribute:

  1. Fork this repository, and clone it to your local device.
  2. Create a new branch off of the dev branch using git checkout -b branch-name origin/dev
  3. Install dependencies with yarn
  4. Run yarn dev to start the local development server on localhost:3000
  5. Add features, commit, and push to the new branch on your fork.
  6. Create a pull request against the dev branch. (This is the branch that will be merged into main when a release is ready).

Note: Backwards compatibility is always wanted. Breaking changes should not be added, unless they have been discussed and determined to be absolutely necessary.

Contributing to the documentation

Contributions to the documentation can be accomplished by following these steps:

  1. Fork this repository, and clone it to your local device.
  2. Create a new branch off of the docs branch using git checkout -b branch-name origin/docs
  3. Install dependencies with yarn
  4. Run yarn dev to start the local development server on localhost:3000
  5. Add features, commit, and push to the new branch on your fork.
  6. Create a pull request against the docs branch.

Considerations

Always refer to the code of conduct when contributing.