Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 2.16 KB
Raw

Contributing to @emitty

Welcome, and thank you for your interest in contributing to @emitty!

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contribution Guideline

There are a couple of ways you can contribute to this repository:

  • Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads.
  • Documentation: Found a typo or strangely worded sentences? Submit a PR!
  • Code: Contribute bug fixes, features or design changes.

Creating an Issue

Before you create a new Issue:

  • Check the Issues on GitHub to ensure one doesn't already exist.
  • Clearly describe the issue, including the steps to reproduce the issue.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:

  • 👍 - upvote
  • 👎 - downvote

Making Changes

Getting Started

  • Install Node.js.
  • Fork the project and clone the fork repository (how to create fork?).
  • Create a topic branch from the master branch.
  • Run yarn or npm install to install the application dependencies.

Setup

git clone https://github.com/mrmlnc/emitty
cd emitty
npm install
npx lerna bootstrap

Then you can either run:

npm run build

For make changes, run the watch:

npx lerna run watch --scope=@emitty/PACKAGE_NAME --stream

To run tests in only one package:

npx lerna run test --scope=@emitty/PACKAGE_NAME --stream

To run tests in all packages:

npm run test

Commit

Keep git commit messages clear and appropriate. You can use Angular guide.