CONTRIBUTING.md

Contributing

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

Table of contents

• Code of conduct
• Reporting bugs
• Request new feature
• Translating
• Code contribution
  • Pull request
  • Styleguides
    • Git commit messages
    • JavaScript styleguide
• Donate

Code of conduct

This project and everyone participating in it is governed by the HaTeMiLe for Browser 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 Browser.

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

If you're unable to find an open issue addressing the problem, open a new one or report the bug by this form.

Request new feature

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

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

If you're unable to find an open issue requesting this feature, open a new one or request the feature by this form.

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

Pull request

1. Install Node.js;
2. Install the dependencies of HaTeMiLe for Browser;
3. Fork the repository;
4. Start coding 😄;
5. Run grunt without arguments;
6. Install the XPInstall file in dist directory;
7. Commit and push your changes;
8. 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: GitHub especific resource
  • 🔖 :bookmark: Version Tag
  • 🔧 :wrench: Tooling

JavaScript styleguide

• Limit the line to 80 characters or less;
• Use four space indentation;
• Not use trailing whitespace in your code;
• Make sure you have a space after commas.
• All variables and functions names must be use camelCase names.

Donate

If you'd like to monetarily support HaTeMiLe for Browser development, you can donate to us by PayPal.