Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (66 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

92 lines (66 loc) · 4.28 KB

Contributing

First off, thank you for considering contributing to HaTeMiLe for Django.

Table of contents

Code of conduct

This project and everyone participating in it is governed by the HaTeMiLe for Django code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to 3837162+carlsonsantana@users.noreply.github.com.

Reporting bugs

This section guides you through submitting a bug report for HaTeMiLe for Django.

Before submitting a bug report check if you're using the latest version of HaTeMiLe for Django and ensure the bug was not already reported.

If you're unable to find an open issue addressing the problem, open a new one issue.

Request new feature

This section guides you through request new feature for HaTeMiLe for Django.

Before submitting a request feature check if you're using the latest version of HaTeMiLe for Django and ensure the feature was not already requested.

If you're unable to find an open issue requesting this feature, open a new one issue.

Translating

To translate the HaTeMiLe you must access our project in Zanata, you will need a account to translate.

Code contribution

If you want submit your code to HaTeMiLe for Django you need follow the code conventions, the styleguides and pull request process.

Pull request

  1. Install Python;
  2. Fork the repository;
  3. Install, create and activate a virtualenv;
  4. Install dependencies;
  5. Start coding 😄;
  6. Commit and push your changes;
  7. Do a pull-request with a short description explaining briefly what you've done.

Styleguides

Git commit messages

  • Limit to one line
  • Limit the line to 72 characters or less
  • Reference issues after comma
  • Start the commit message with an applicable emoji:
    • 🎉 :tada: Initial commit
    • 🎨 :art: Cosmetic
    • 🐎 :racehorse: Performance
    • 📝 :memo: Documentation
    • 🐛 :bug: Bugfix
    • 🔥 :fire: Remove code
    • ✅ :white_check_mark: Tests
    • ✨ :sparkles: New Feature
    • ♻️ :recycle: Refactoring
    • 🌐 :globe_with_meridians: Internationalization
    • :octocat: :octocat: GitHub especific resource
    • 🔖 :bookmark: Version Tag
    • 🔧 :wrench: Tooling
    • 🔒 :lock: Security
    • ✔️ :heavy_check_mark: Tests

Python styleguide

The HaTeMiLe for Django follow the PEP 8 -- Style Guide for Python Code and the most of Pylint rules.

Donate

If you'd like to monetarily support HaTeMiLe for Django development, you can:

  • Donate to us by PayPal;
  • Donate Bitcoin to 1EhnFFHv2MheyNHViwYWhKjSWoVjSnJMzA wallet address;
  • Donate Ethereum to 0x1f9b88c3fbd4823eac4910f456a4036e24e87f5b wallet address;
  • Donate Litecoin to LhLTYbH2CwCuAHEkedvmHyTBQTWfCb2aK3 wallet address;
  • Donate Dogecoin to DECZbbUb8kGKau8ycUmdgmfaPbkBTaApjQ wallet address;
  • Donate Tether to 1EnvcNeo1gp27h8mVLMgMuiJvq8UHCENdX wallet address.