35b283204a
* Update CONTRIBUTING.md Signed-off-by: Matt Ramotar <mramotar@dropbox.com> * Fix formatting --------- Signed-off-by: Matt Ramotar <mramotar@dropbox.com>
28 lines
2 KiB
Markdown
28 lines
2 KiB
Markdown
# Contributing to Store
|
|
Thanks for considering contributing to Store. This document provides guidelines and information about how you can contribute.
|
|
|
|
## Getting Started
|
|
- **Fork the Repository**: Start by forking the [MobileNativeFoundation/Store](https://github.com/MobileNativeFoundation/Store) repository.
|
|
- **Clone the Fork**: Clone your fork to your machine to start working on the changes.
|
|
|
|
## Contribution Workflow
|
|
### Reporting Issues
|
|
- **Search Existing Issues**: Before creating a new issue, please do a search in existing issues to see if it has been reported or fixed.
|
|
- **Create a Detailed Issue**: If you find a bug or have a feature request, please create an issue with a clear title and a detailed description.
|
|
### Submitting Changes
|
|
- **Create a Branch**: Create a branch in your fork for your contribution.
|
|
- **Make Your Changes**: Make your changes and commit them to your branch. Make sure to write clear, concise commit messages.
|
|
- **Write Tests**: If you are adding new features or fixing bugs, write tests that cover your changes.
|
|
- **Run the Tests**: Run the project's existing tests to ensure nothing is broken.
|
|
- **Create a Pull Request**: Submit a PR to the main repository for review. Include a clear description of the changes and any relevant issue numbers.
|
|
### Code Review Process
|
|
- **Wait for Review**: Maintainers will review your PR and might request changes.
|
|
- **Make Requested Changes**: If changes are requested, make them and update your PR.
|
|
- **Merge**: Once your PR is approved, a maintainer will merge it into the main codebase.
|
|
|
|
## Community Guidelines
|
|
- **Be Respectful**: Treat everyone with respect. We strive to create a welcoming and inclusive environment.
|
|
- **Follow the Code of Conduct**: Familiarize yourself with our [Code of Conduct](https://github.com/MobileNativeFoundation/Store/blob/main/CODE_OF_CONDUCT.md).
|
|
|
|
## Getting Help
|
|
- **Join the Community**: If you have questions or need help, join our [Slack channel](https://kotlinlang.slack.com/archives/C06007Z01HU).
|