Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 2.31 KB
Raw

Contributing to Splitr

Thank you for considering contributing to Splitr! ❤️ We welcome contributions from the community to help improve and enhance the app. To ensure a smooth and consistent contribution process, please follow the guidelines outlined below.

If you like the project, but just don't have time to contribute, there are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Use the application
  • Star the project
  • Mention the project to your surroundings

I have an issue

Before asking a question or submitting a new bug report, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write in this issue.

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

  • Make sure that you use the latest version of the application.
  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions, depending on what seems relevant.

I want to contribute

Legal notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Code Style

Please ensure that your code follows the existing code style conventions. We use the Dart language and follow the effective Dart guidelines. To maintain code consistency, consider using the Dart formatter to format your code automatically.

Some hooks are also provided. To use them automatically, run

chmod +x .githooks/*
git config core.hooksPath .githooks

Submitting changes

Here are the recommands steps to follow to submit your changes.

  1. Fork the splitr repository on GitHub.
  2. Create a new branch from the master branch with a descriptive name for your changes.
  3. Ensure to follow the current guidelines.
  4. Open a pull request (PR) against the master branch.
  5. Provide a detailed description of your changes in the PR, including any relevant information or context.

Thank you for your contribution! We appreciate your effort in making Splitr better.