Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution guide #676

Merged
merged 5 commits into from
Sep 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing to Chatto

## Asking a Question

Please don't file an issue just to ask a question.
You'll get a faster response in [our Gitter room](https://gitter.im/chatto-framework/community)

## Reporting a Bug

### Before Submitting a Bug Report

- **Make sure you're on the latest version.** If you're not on the most recent version, your problem may have been solved already. Upgrading is always the best first step.
- **Try older versions.** If you're already on the latest release, try rolling back a few minor versions and see if the problem goes away. This will help devs narrow down when the problem first arose in the commit log.
- **Try searching the [list of opened issues](https://github.com/badoo/Chatto/issues?q=is%3Aissue+is%3Aopen)** to see if the problem has already been reported. If it has, please add a comment to the existing issue instead of opening a new one.

### What To Put In Your Bug Report

Explain the problem and include additional details to help maintainers reproduce the problem:

- **Use a clear and descriptive title** for the issue.
- **Describe the exact steps to reproduce the problem** in as many details as possible.
- **Provide code samples.**
- **Include screenshots and animated GIFs** which could clearly demonstrate the problem. You can use [this tool](https://www.cockos.com/licecap/) to capture GIFs on macOS
- **Explain which behaviour you expect to see and why.**
- **Provide information about your environment.**
- Chatto version
- iOS version
- Xcode version
- **Add info how Chatto is intergrated** to your project. Is it CocoaPods, Carthage or manual?

## Contributing Changes

If you'd like to introduce new functionality or fix a bug, it's always best to discuss it with us in [our Gitter room](https://gitter.im/chatto-framework/community).

When creating a pull request please consider following:

- **Always make a new branch** for your work. This makes it easier for others to take just one set of changes form your repository.
- **Please do not submit unrelated changes** in the same pull request.
- **Use a clear and descriptive title** for the pull request.
- **Describe a clear list of things** that you have done in this pull request.
- **Include relevant issue number** if applicable.
- **Consider enabling "Allow edits by maintainers" checkmark.** So we could push additional changes in your pull request.
- **Consider adding unit tests.** We'd be really grateful if you add unit test for your feature/bugfix!
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@

Check the [wiki!](https://github.com/badoo/Chatto/wiki)

## How to contribute

If you **just have a question**, please reach us in [our gitter room](https://gitter.im/chatto-framework/community)

If you'd like to file a bug report, suggest changes or submit a pull request, please [check our contribution guide](.github/CONTRIBUTING.md)

## How to install
### CocoaPods

Expand Down