Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 3 KB
Raw

Contributing guide

This file outlines how you can contribute to design_tokens_builder.
If you are new to contributing on GitHub, you might want to see the setup section below.

Setting up your repo

Fork the design_tokens_builder repository

  • Ensure you have configured an SSH key with GitHub; see GitHub's directions.
  • Fork this repository using the "Fork" button in the upper right corner of the GitHub page.
  • Clone the forked repo: git clone [email protected]:<your_github_user_name>/design_tokens_builder.git
  • Navigate into the project: cd design_tokens_builder
  • Add this repo as a remote repository: git remote add upstream [email protected]:simpleclub/design_tokens_builder.git

Create pull requests

  • Fetch the latest repo state: git fetch upstream

  • Create a feature branch: git checkout upstream/master -b <name_of_your_branch>

  • Now, you can change the code necessary for your patch.

    Make sure that you bump the version in pubspec.yaml. You must bump the Pubspec version when a new package version should be released and edit the CHANGELOG.md accordingly.
    The version format needs to follow Dart's versioning conventions. See this article for everything you need to know about that. Pay special attention when landing breaking changes.

  • Commit your changes: git commit -am "<commit_message>"

  • Push your changes: git push origin <name_of_your_branch>

After having followed these steps, you are ready to create a pull request.
The GitHub interface makes this very easy by providing a button on your fork page that creates a pull request with changes from a recently pushed to branch.
Alternatively, you can also use git pull-request via GitHub hub.

Notes

  • Always add tests or confirm that your code is working with current tests.
  • Use dart format . --fix to format all code.
  • Adhere to the lints, i.e. the warnings provided by Dart's linter based on the repo's lint rules.
    Run flutter analyze in order to ensure that you are not missing any warnings or errors.
  • If you find something that is fundamentally flawed, please propose a better solution - we are open to complete revamps.

Contributor License Agreement

We require contributors to sign our Contributor License Agreement (CLA). In order for us to review and merge your code, please follow the link and sign the agreement.