devkabiir / travis_ci

Helper utilities for scripts running under Travis CI environment

Travis CI

About

Helper utilities for scripts running under Travis CI environment

Usage

Add travis_ci to dependencies

dependencies:
  ...
  travis_ci:
    git: https://www.github.com/devkabiir/travis_ci

Use inside your scripts

e.g. <your-project>/bin/my_script.dart

import 'package:travis_ci/travis_ci.dart' as travis;

void main() => print('Is script running under TRAVIS? : ${travis.isCi}');

Contributing

• 🍴 Fork this repo

• Clone your forked version
  git clone https://github.com/<you>/travis_ci.git

• ➕ Add this repo as a remote
  git remote add upstream https://github.com/devkabiir/travis_ci.git

• ⏫ Make sure you have recent changes
  git fetch upstream

• ✨ Make a new branch with your proposed changes/fixes/additions
  git checkout upstream/master -b name_of_your_branch

• 📑 Make sure you follow guidelines for Git

• Push your changes
  git push origin name_of_your_branch

• Make a pull request

Git

• ✅ Sign all commits. Learn about signing-commits
• Use commitizen with cz-emoji adapter
• Check existing commits to get an idea
• Run the pre_commit script from project root pub run pre_commit
• If you're adding an and in your commit message, it should probably be separate commits
• Link relevant issues/commits with a # sign in the commit message
• Limit message length per line to 72 characters (excluding space required for linking issues/commits)
• Add commit description if message isn't enough for explaining changes

Code style

• Maintain consistencies using included .editorconfig
• Everything else as per standard dart guidelines

Testing

• Add tests for each new addition/feature
• Do not remove/change tests when refactoring
  • unless fixing already broken test.

Features and bugs

Please file feature requests and bugs at the issue-tracker.

License

Copyright (C) 2018 Dinesh Ahuja [e-mail]

Please see the LICENSE file in this repository for the full text