Skip to content

Latest commit

 

History

History
99 lines (72 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

99 lines (72 loc) · 4.21 KB
Raw

Contributing

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

Table of contents

Code of conduct

This project and everyone participating in it is governed by the HaTeMiLe for Java code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Reporting bugs

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

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

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

Request new feature

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

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

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

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 Java you need follow the code conventions, the styleguides and pull request process.

Pull request

  1. Install Maven;
  2. Fork the repository;
  3. Start coding 😄;
  4. Execute the command mvn test to test;
  5. Commit and push your changes;
  6. 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

Java styleguide

Run the command mvn test in path of HaTeMiLe for Java to test if the Java files follow these styleguide.

  • All class names must be UpperCamelCased;
  • All properties names must be camelCased;
  • All constants names must be CONSTANT_CASE;
  • Use four space indentation;
  • Lines can be no longer than eighty characters;
  • Not use trailing whitespace in your code;
  • Operators must have spaces around them;
  • Make sure you have a space after commas.

Donate

If you'd like to monetarily support HaTeMiLe for Java 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.