Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.55 KB

CONTRIBUTING.MD

File metadata and controls

43 lines (31 loc) · 1.55 KB

Contributing

🎉 Thank you for considering contributing to queue-xec! 🎉

Contributors are always welcome! Any single line of code maters! Don't hesitate to correct even a typo!

Before anything else, check issues. If issue exist in any condition (closed, assigned, stalled), comment and share your thoughts there. It's nice to have all subject related discussions, organized in one place.

If you can't find any issue related to your current issue you want to contribute, go ahead and open it! After verification, issues will be assigned to you.

Then you can start working on that issue.

How to setup environment

It is recommended to have both worker and master in their latest versions. So : Fork master and worker

mkdir queue-xec
cd queue-xec
git clone https://github.com/<your_username>/master
git clone https://github.com/<your_username>/worker
cd worker ; yarn
cd ../master ; yarn
git checkout -b my_new_feature
... make your changes
git commit

After environment setup

Start working on your test in develpment mode by :

yarn run test:dev

Create unit test in parallel of actual feature. No pull request will be accepted if not contains new unit tests if introduce new features , or fixes of bugs!

On git commit :

After all test passed , commitizen will fire up and start asking questions about your commit.(Be honest)

If you have any issue during this , check issues , if cant found something related , open a new issue , any other contributor can help you.