Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.13 KB
Raw

Contributing to Vortex

Welcome! Thank you for your interest in Vortex. Before contributing, please review the guidelines below.

Reporting Issues

Found a bug? Have an improvement to suggest? Please file a GitHub issue. Before you create a new issue, please ensure that a relevant issue doesn't already exist by running a quick search of existing issues. If you're unable to find an open issue, then please open a new one.

Code Contributions

The contribution process is outlined below:

  1. Start a discussion by creating or commenting on a GitHub Issue (unless it's a very minor change).

  2. Implement the change.

    • If the change is large, consider posting a draft pull request (PR) with the title prefixed with [WIP], and share with the team to get early feedback.
    • Give the PR a clear, brief description; this will be the commit message when the PR is merged.
    • Make sure the PR passes all CI tests.

  3. Open a PR to indicate that the change is ready for review.