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

Latest commit

 

History

History
58 lines (45 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

58 lines (45 loc) · 2.32 KB

🤝 How Can I Contribute?

Contributions, issues and feature requests are welcome.

  • You can look at coogger's codacy analysis and send a pull-request issue to help improve coogger's code quality. Codacy address
  • You can follow marked with help wanted tag issues opened in Github and if you want to solve this issue you can write that 'you can assign this issue to me', and you can fork, solve than create a new pull-request. Marked with help wanted tag issues
  • If you have ideas on issues with a brainstorming badge, you can share your ideas and contribute to the development of this feature. Marked with help brainstorming tag issues
  • Using the Coogger project, you can report any problems you have seen to us using issues. issues page
  • You can interpret the design of the Coogger project and help improve the design of the coogger by providing feedback. wwww.coogger.com
  • You can also contribute by moving your blogs, documents or tutorials to the coogger or by generating new resources in the coogger. wwww.coogger.com

Styleguides

Code Style

Black

We use black to code style, here is original repo psf/black check and learn how to convert python files code style to black.

when sending a pull request, make sure that the style of your code this style.

Isort

.isort.cfg isort config

[settings]
multi_line_output=5

when sending a pull request, make sure that the style of your code this style.

Git Commit Messages

  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings