Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.63 KB

Contributing to Lava

Thank you for considering contributing to Lava! We welcome contributions of all types, from code and documentation to design and outreach.

Please note that all contributors are expected to follow the guidelines in our CODE OF CONDUCT file. This document sets out the standards of behavior expected from contributors to the project.

Types of Contributions

Here are some ways you can contribute to Lava:

  • Submit bug reports. If you find a bug in Lava, you can submit an issue to the project's issue tracker. See format here: ISSUE_TEMPLATE

  • Contribute code (please see our coding guidelines below). If you're a developer and want to contribute code to Lava, you can fork the repository and submit a pull request with your changes.

  • Test and review pull requests. Lava relies on the contributions of many people, and every pull request needs to be reviewed and tested before it can be merged. You can help by testing pull requests and providing feedback on their functionality and quality.

  • Help with outreach and community building. Lava is a community-driven project, and we rely on the participation of our users and contributors to succeed. You can help by spreading the word about Lava, answering questions on community forums, and helping to build a positive and inclusive community.

Getting Started

If you're new to contributing to open source projects, we recommend checking out the Open Source Guides for an introduction to the process.

To get started with contributing to Lava, familiarize yourself with the project by reading the project's litepaper, Repo's README and documentation, trying out the project, and joining the project's Discord channels to ask questions and learn from other contributors.

Support is detailed in SUPPORT.md

Coding Guidelines

Please follow these guidelines when contributing code to Lava:

  • Include tests for any new code
  • One PR per issue/bug
  • PR Subject line:
    • use imperative mode (e.g. "Add feature X" instead of "Adding feature X")
    • Keep sentance short, concise and human readable
    • Format sentance in proper english, start in capital word
    • If fixing a bug, state the fix ("what channged") and not was the original bug
  • Make sure your code is well-documented and easy to understand
  • If you're making a lot of changes, it's a good idea to break your work into smaller, self-contained pull requests
  • TBD - Per project coding style

The PR Template is covering some of these aspects