Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 4.94 KB

CONTRIBUTING.md

File metadata and controls

77 lines (50 loc) · 4.94 KB
Raw

Welcome to Lava docs contributing guide

First of all - THANK YOU for taking the time to contribute! 🌋👍

This website is built using Docusaurus 2, all your changes will be reflected on Lava Docs @ docs.lavanet.xyz

How can you help 💪?

  1. Report an issue/mistake you found
  2. Suggest a fix via PR (read below)
  3. Want to add new content/tutorials? Please propose it first via a new issue, and only then write it up, to save you time

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of Lava, read the Docs Intro.

This repository aligns with best practices for contributing to open source as you will find in many repositories on GitHub. If you are not familiar with these, please start with these great resources:

Styleguide

Lava docs serves multiple user types in different lifecycle steps. We want to create a doc resource that will fit all, but have a common denominator of style.

Styleguides are guidance and not a restriction, good articles we picked for this purpose are:

Getting started

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes to content

Click Make a contribution at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .md file where you can make your changes and create a pull request for a review.

Make changes locally

  1. Install Git
  2. Fork the repository
  3. Clone it to your working space
  4. Run a local version using $ yarn start
  5. Create a working branch and start with your changes!

Commit & Pull Request

Commit the changes once you are happy with them.

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🦸 Lava thanks you 🌋🙏.

Once your PR is merged, your contributions will be publicly visible on the Lava Docs

Thanks goes to GitHub Docs for inspiration on writing this contribution text