Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 2.07 KB

Contributing to the project

Thank you for your interest in contributing to this project. 🥳 This project is open to contributions. If you have any ideas, suggestions, or improvements, feel free to open an issue or a pull request.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@myalbum.com

How to contribute

  1. Fork the repository
  2. Install the dependencies with yarn install
  3. Bootstrap the example project with yarn bootstrap
  4. Start one of the example projects. Expo with yarn expo or bare with yarn bare
  5. Make your changes
  6. Run the tests with yarn test
  7. Commit your changes
  8. Push to your fork and submit a pull request

Issues

Issues are tracked here.

Languages

We accept issues only on English. It is acceptable and encouraged to post an English translation of the issue if you are not a native English speaker. This will help maintainers and other contributors to understand the issue better.

Please note that using non-English as an attempt to circumvent our code of conduct will be an immediate, and possibly permanent, ban from the project.

Pull requests

Pull requests are welcome. Before submitting a pull request, please make sure that your changes are well tested. See above for instructions on how to contribute.

Dependencies updates

Dependencies should only be altered by maintainers. If you find a security vulnerability or a bug in a dependency, please report it in an issue. For security reasons, we do not accept pull requests that alter our package.json or yarn.lock files.

Style guide

This project uses Prettier to format the code. When using Visual Studio Code, you can install the Prettier extension to format the code automatically on save. You can also run yarn format to format the code.