Skip to content
This repository has been archived by the owner on Mar 11, 2020. It is now read-only.

Latest commit

 

History

History
43 lines (29 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.87 KB
Raw

Contributing to importify

👋 Greetings Traveler!

I'm really glad you're reading this, I really appreciate the effort you're taking. Thank you for your help in making this tool awesome!:sparkles:

How to contribute

Report bugs or feature request

If you found any bugs or have any proposals how to make this project better don't hesitate to create issues here in free format.

Create a PR

We love pull requests from everyone. But, please, don't create PR without corresponding issue. It's always better to discuss your future work first.

To get started with this you should first fork, then clone the repo:

git clone git@github.com:your-username/importify.git

Make your changes and consider the following check list to go through before submitting your pull request.

✅ Check list

  • Project compiles
  • New/fixed features work as expected
  • Old features do not break after the change
  • Commit messages are in the proper format. If the commit addresses an issue start the first line of the commit with the issue number in square parentheses.
    • Example: [#42] Short commit description
    • Recomended: add emoji to commit according to this guide

If you fix bugs or add new features, please add tests following next instructions:

  1. Create files with example in test-data folder with .hs extension.
  2. Run stack exec golden-generator.
  3. Verify manually new generated files with .golden extension.

After all above is done commit and push to your fork. Now you are ready to submit a pull request.

Thanks for spending time on reading this contributing guide! 💖