Skip to content

Latest commit

 

History

History
106 lines (75 loc) · 4.88 KB

CONTRIBUTING.md

File metadata and controls

106 lines (75 loc) · 4.88 KB
Raw

Contribution Guidelines

Note: If these contribution guidelines are not followed your issue or PR might be closed, so please read these instructions carefully.

See also: Invertases's code of conduct

About

Melos is a tool that optimizes the workflow around managing multi-package repositories with git and Pub.

Contribution types

Bug Report

  • If you find a bug, please first report it using GitHub issues.
    • First check if there is not already an issue for it; duplicated issues will be closed.

Bug Fix

  • If you'd like to submit a fix for a bug, please read the How To for how to send a pull request.
  • Indicate on the open issue that you are working on fixing the bug and the issue will be assigned to you.
  • Write Fix #xxxx in your PR text, where xxxx is the issue number (if there is one).
  • Include a test that isolates the bug and verifies that it was fixed.

New Features

  • If you'd like to add a feature to the library that doesn't already exist, feel free to describe the feature in a new GitHub issue.
  • If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, enhancements may not align well with the project future development direction.
  • If applicable, implement the code for the new feature and please read the How To.

Documentation & Miscellaneous

  • If you have suggestions for improvements to the documentation or examples (or something else), we would love to hear about it.
  • As always first file a GitHub issue.
  • Implement the changes to the documentation, please read the Docs section.

How To Contribute

Requirements

Forking & cloning the repository

  • Ensure all the dependencies described in the previous section are installed.
  • Fork https://github.com/invertase/melos into your own GitHub account. If you already have a fork, and are now installing a development environment on a new machine, make sure you've updated your fork so that you don't use stale configuration options from long ago.
  • git clone [email protected]:<your_name_here>/melos.git
  • git remote add upstream [email protected]:invertase/melos.git (So that you fetch from the main repository, not your clone, when running git fetch or git pull

Local development setup

To setup and use this melos mono repo locally for the purposes of contributing, clone it and run the following commands from the root of the repository:

# Install melos if it's not already installed:
dart pub global activate melos
# Bootstrap the workspace.
melos bootstrap
# Activate 'melos' from path:
melos activate
# Confirm you now using a local development version:
melos --help
# You should now see a banner printed at the top of the help output similar to:
# ---------------------------------------------------------
# | You are running a local development version of melos. |
# ---------------------------------------------------------

Performing changes

  • Create a new local branch from main (e.g. git checkout -b my-new-feature)
  • Make your changes (try to split them up with one PR per feature/fix).
  • When committing your changes, make sure that each commit message is clear (e.g. git commit -m 'docs: Add CONTRIBUTING.md').
  • Push your new branch to your own fork into the same remote branch (e.g. git push origin my-username.my-new-feature, replace origin if you use another remote.)

Docs

When editing the documentation, once you have submitted your Pull Request (PR) and pipeline has passed, you can preview your changes on: https://melos.invertase.dev/~{PR_NUMBER}.

Open a pull request

To send us a pull request:

  • Go to https://github.com/invertase/melos and click the "Compare & pull request" button

Please make sure all your check-ins have detailed commit messages explaining the patch.

When naming the title of your pull request, please follow the Conventional Commits guide.

Please also enable “Allow edits by maintainers”, this will help to speed-up the review process as well.