Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

59 lines (44 loc) · 1.71 KB

Contributing Guide

Reporting an Issue

  1. Open an issue on GitHub
  2. Describe the issue
  3. Include any logs or stacktraces in a Markdown fenced block
  4. Consider opening a Pull Request resolving the issue.

Requesting a Feature

  1. Open an issue on GitHub
  2. Describe the feature
    • Provide an example if possible
    • Include links to external references as needed
  3. Consider opening a Pull Request

Sharing Documentation

  1. Create a fork of the repository
  2. Create a feature branch
  3. Make changes
  4. Commit changes
  5. Push branch
  6. Open pull request to ChristianMurphy/selective on the master branch

Sharing Code

  1. Create a fork of the repository
  2. Install the project
  3. Create a feature branch
  4. Make changes
  5. Test changes
  6. Commit changes
  7. Push branch
  8. Open pull request to ChristianMurphy/selective on the master branch

Installation

Requirements

  1. Git
  2. Node.js
  3. Yarn
  4. Lerna

Setup

  1. git clone https://github.com/ChristianMurphy/selective
    • 📓 alternatively replace ChristianMurphy/selective with a fork name
    • If installing a fork additionally run git remote add upstream https://github.com/ChristianMurphy/selective
  2. cd selective
  3. yarn
  4. lerna bootstrap

Testing

  1. yarn test
  2. yarn lint