Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShadBalti authored Nov 1, 2023
1 parent d0e6426 commit 82d7b9c
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@

## Introduction

This document provides guidelines for contributing to the Simple Image Editor project.

## How to contribute

There are many ways to contribute to the Simple Image Editor project. Here are a few ideas:

* **Fix bugs.** If you find a bug in the code, please report it by creating a new issue on GitHub.
* **Add new features.** If you have an idea for a new feature, please submit a proposal by creating a new issue on GitHub.
* **Improve the documentation.** If you find the documentation to be unclear or incomplete, please submit a pull request to make the necessary changes.
* **Write tests.** If the code is not well-tested, please write tests to improve the code coverage.
* **Translate the app into a new language.** If the app is not yet available in your language, please submit a pull request to add a translation.

## Getting started

To get started contributing to the Simple Image Editor project, please follow these steps:

1. Fork the repository on GitHub.
2. Clone the forked repository to your local machine.
3. Install the dependencies.
4. Create a new branch for your work.
5. Make the changes you want to make.
6. Write unit tests for your changes.
7. Commit your changes to the new branch.
8. Push the new branch to your forked repository.
9. Create a pull request to merge your changes into the main repository.

## Code style guidelines

The Simple Image Editor project follows the Google Java Style Guide: https://google.github.io/styleguide/javaguide.html. Please make sure that your code follows these guidelines when submitting a pull request.

## Testing guidelines

The Simple Image Editor project uses JUnit for unit testing. Please write unit tests for any new code that you add.

## Documentation guidelines

The Simple Image Editor project uses Sphinx to generate the documentation. Please make sure that your documentation is well-written and easy to understand.

## Translation guidelines

The Simple Image Editor project uses Crowdin to manage translations. If you would like to translate the app into a new language, please create a new project on Crowdin and follow the instructions on the Crowdin website.

## Questions?

If you have any questions about contributing to the Simple Image Editor project, please feel free to ask. You can create a new issue on GitHub or send an email to the project maintainers.

## Thank you!

Thank you for your interest in contributing to the Simple Image Editor project. We appreciate your help in making the app better for everyone!

0 comments on commit 82d7b9c

Please sign in to comment.