Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

30 lines (18 loc) · 1.92 KB

How to Contribute

✨🎊 Thanks for contributing! 🎊✨

Before implementing new notebooks or scripts, feel free to submit an issue explaining what we should add or change. We can talk there 😊.

I don't want to read this whole thing I just have a question!!!

Please don't file an issue to ask a question. You'll get faster results by joining our Telegram group and asking there.

If your question is about a lack of clarity of the code or study, consider submiting an issue for better documentation. The next section will explain you how.

How Can I Contribute?

  1. Did you find a mistake or want to suggest another study? First, ensure the suggestion was not already made by searching on GitHub under Issues. Lack of proper documentation is also suggested to be filed under Issues.

  2. If the issue is not suggested, open a new one. Include a clear title and description, with as much relevant information as needed.

  3. After the issue is created, if you want to resolve it, you can fork the repository, work there to then submit a pull request.

  4. This repository follows gitmoji😎 commit standard. Please, follow this standard to provide an easy way of identifying the purpose or intention of your commit. And always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

    $ git commit -m ":emoji: A brief summary of the commit
    > 
    > A paragraph describing what changed and its impact."
    

Aaaaand that's it!

Thank you very much for contributing.