ec4ef9aa04
* Update from hummingbird-project-template 572d468b2cabeca286314c5a35196bd42445c8ef * run swift-format * Remove .swiftformat --------- Co-authored-by: adam-fowler <adam-fowler@users.noreply.github.com> Co-authored-by: Adam Fowler <adamfowler71@gmail.com>
31 lines
1.4 KiB
Markdown
31 lines
1.4 KiB
Markdown
# Contributing
|
|
|
|
## Legal
|
|
By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch
|
|
that your contributions are licensed under the Apache 2.0 license (see [LICENSE](LICENSE)).
|
|
|
|
## Contributor Conduct
|
|
All contributors are expected to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
|
|
## Submitting a bug or issue
|
|
Please ensure to include the following in your bug report
|
|
- A consise description of the issue, what happened and what you expected.
|
|
- Simple reproduction steps
|
|
- Version of the library you are using
|
|
- Contextual information (Swift version, OS etc)
|
|
|
|
## Submitting a Pull Request
|
|
|
|
Please ensure to include the following in your Pull Request
|
|
- A description of what you are trying to do. What the PR provides to the library, additional functionality, fixing a bug etc
|
|
- A description of the code changes
|
|
- Documentation on how these changes are being tested
|
|
- Additional tests to show your code working and to ensure future changes don't break your code.
|
|
|
|
Please keep your PRs to a minimal number of changes. If a PR is large try to split it up into smaller PRs. Don't move code around unnecessarily it makes comparing old with new very hard.
|
|
|
|
The main development branch of the repository is `main`.
|
|
|
|
### Formatting
|
|
|
|
We use Apple's swift-format for formatting code. PRs will not be accepted if they haven't be formatted. |