Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (60 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

91 lines (60 loc) · 1.71 KB
Raw

Contributing to Phase Docs

We're excited that you're interested in contributing to Phase Docs! This document outlines the process for contributing and provides instructions for setting up the project locally.

How to Contribute

  1. Fork the repository.
  2. Create a new branch for your contribution.
  3. Make your changes.
  4. Submit a pull request with a clear description of your changes.

Setting Up the Development Environment

Installation

You can install the project dependencies using either npm or yarn:

npm

npm install

yarn

yarn install

Development

To run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Building

To build the project:

npm run build
# or
yarn build

This command will also generate a sitemap automatically after the build process.

Starting the Production Server

To start the production server:

npm run start
# or
yarn start

Linting

To run the linter:

npm run lint
# or
yarn lint

Documentation

  • Update the documentation if you're changing functionality.
  • Use clear and concise language in your documentation.
  • Provide examples where appropriate.

Submitting Changes

  1. Push your changes to your fork.
  2. Submit a pull request to the main repository.
  3. Clearly describe your changes and why you think they should be merged.
  4. Be prepared to address any feedback or questions about your pull request.

Questions?

If you have any questions or need further clarification, you can get in touch with on in your Community Slack.

Thank you for contributing to Phase Docs!