Skip to content

Latest commit

 

History

History
94 lines (60 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

94 lines (60 loc) · 2.48 KB
Raw

Contributing to Chainstack Documentation

Get involved! Whether you want to report an issue, fix a typo, or have an idea on what should be covered in the Chainstack documentation, we welcome everyone.

Table of Contents

Documentation

The Chainstack documentation website is based on VuePress.

Install dependencies after cloning:

$ npm install

Working with Issues

Issue tracker

Click Issues in the repository to see the reported issues.

Feel free to look around and comment.

Submitting an Issue

Hit New issue.

You are welcome to submit any issue:

  • Bug
  • Typo
  • Feature request
  • Topic idea

Pull Requests

Intent

The goals of contributing to the Chainstack documentation:

  • Maintain the documentation quality, developer experience, user experience
  • Fix issues that are important to developers and users
  • Engage the community to make the best possible Chainstack experience

Instructions

Branching

  • Do work in a branch with a descriptive name
  • Update your local branch and do an interactive rebase before pushing your work and making a Pull Request
  • Resolve potential conflicts while rebasing and before making a Pull Request
  • Do a local build/run before making a Pull Request. See Building.

Commit messages

Based on Chris Beam's How to Write a Git Commit Message.

  • Provide a meaningful subject
  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
  • Wrap the body at 72 characters
  • Use keywords to reference Issues. See Closing issues using keywords.

Building

Doing a local build

$ npm run build

The assets will be generated in docs/.vuepress/dist.

Doing a local run

$ npm run dev

The website will be running on http://127.0.0.1:8080.

Communication

Talk to us on Gitter.