Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 2.22 KB
Raw

Contributing to costro.js.org

Thanks for being interesting on Costro! Before submitting your contribution, be sure to take a moment and read the following guide.

This site is built with Docusaurus. The content of the site is written in Markdown format. Pull requests are welcome.

Installation

  1. Make sure that Node.js version 16+ and npm are installed.
  2. After cloning the repository, run npm install at the root of the repository.
  3. To start the development server, run npm start.

List of npm scripts available:

Development

# Run development server
npm run start

Tests

# Run Markdown linter
npm run test:markdown

Production

# Build the source code for distribution
npm run build

Pull requests

You can learn how to work on your first pull request from this series of free video: How to contribute to an open source project on GitHub

Keep the pull requests as small as possible, it's much easier to review. Make sure the PR only does one thing, otherwise please split it.

Make sure the following is done when submitting a pull request:

  1. Fork the repository and create your branch from main.
  2. Make sure test passes, run npm run test.

Project structure

  • ./config - Contains configuration files (Prettier).
  • ./docs - Contains the Markdown files for the Docs section.
  • ./sidebar - Contains the sidebar configuration files.
  • ./src - Contains the custom code for MDX, JSX and the home page.
  • ./static - Contains static files. All files are automatically moved to the root directory during build.
  • ./tutorial - Contains the Markdown files for the Tutorial section.

License

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