Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 2.46 KB

Contributing

Thank you for your interest in contributing to Meteor Docs! We appreciate your time and effort to help make our documentation better.

Please take a moment to review these guidelines before submitting any contributions.

If you want to contribute, but aren't sure where to start, you can create a issue.

Getting Started

  1. To start contributing to the project, clone it to your local machine using git:

    git clone https://github.com/meteor-web3/developer-docs.git
  2. Ensure you have Node.js and PNPM installed on your local machine. You can run the following commands in your terminal to check your local Node.js and pnpm versions:

    node -v 
    pnpm -v

    If the versions are not correct or you don't have Node.js or pnpm installed, install the Node.js and pnpm from their official website.

  3. Install the necessary dependencies by running the following command in the root of the project directory.

    pnpm install
  4. This project is built using Next.js, to get started with the project, run the following command in the root of the project directory.

    pnpm run dev

    This will start the development server and you can view the app at http://localhost:3000/.


✅ Now you're ready to contribute to Meteor docs! Follow the next steps to learn more about making and submitting changes.

Making Changes

  • Before making any changes, please review the existing documentation to ensure that your contribution is not duplicating content that already exists.
  • Make your changes in the appropriate files, using clear and concise language.
  • Ensure that your changes are formatted consistently with the rest of the documentation.
  • If your changes include code snippets, please ensure that they are accurate and functional.

Submitting Changes

  • Once you have made your changes and tested them, commit your changes and push them to your fork.
  • Create a pull request from your branch to the main repository.
  • Your pull request will be reviewed by our team, and we may ask for revisions or additional information before merging your changes.

Formatting Guidelines

  • Use simple and concise language.
  • Use proper grammar and spelling.
  • Use headings to break up sections of text.
  • Use code blocks for code examples.
  • Use lists for step-by-step instructions.