Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (47 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 4.05 KB

Contributing to GitLocalize

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the GitLocalize Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to contact@gitlocalize.com.

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues in the specific repository that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Join our Discord Community and ask in the relevant channel.
  • Open an Issue in the relevant repository using the "Question" template.

I Want To Contribute

Reporting Bugs

Before creating bug reports, please check this list as you might find out that you don't need to create one:

  • Check the documentation for a list of common questions and troubleshooting.
  • Search existing issues to see if the bug has already been reported.

If you find an unrecorded bug, please open a new issue in the repository where the bug exists.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for GitLocalize, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful to most GitLocalize users.

Finding Issues

Unsure where to begin contributing to GitLocalize? You can start by looking through good-first-issue and help-wanted labels on our repositories.

Pull Requests

The process described here has several goals:

  • Maintain GitLocalize's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible tools

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow the template: Most repositories have a Pull Request template. Please fill it out accurately.
  2. Adhere to Style Guides: Please respect the linting and style guides specific to the language of the repository (e.g., RuboCop for Ruby, ESLint for JavaScript).
  3. Verify Checks: After you submit your pull request, verify that all status checks (CI/CD) are passing.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.