Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Updates to contribution guidelines
  • Loading branch information
eliabsisay authored Jul 11, 2024
1 parent 09f28d3 commit 16085cf
Showing 1 changed file with 34 additions and 18 deletions.
52 changes: 34 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,42 @@
Contributing
============
# Contributing

## Contributing License Agreement
Before code can be accepted all contributors must complete our [Individual Contributor License Agreement (CLA).](https://forms.gle/SjXadmUcVwh6NrU68)
Thank you for participating in this project!

## Pull Request
If you would like to contribute code you can do so through GitHub by
forking the repository and sending a pull request.
This document provides some basic guidelines for contributing to this repository. To propose improvements, feel free to submit a pull request or open an issue.

When submitting code, please make every effort to follow existing conventions
and style in order to keep the code as readable as possible. Please also make
sure your code compiles by running `./gradlew check`.
## Requirements

Some general advice
Before code can be accepted all contributors must read the [**code of conduct**](https://github.com/embrace-io/embrace-android-sdk/blob/master/CODE_OF_CONDUCT.md) and complete our [**Individual Contributor License Agreement (CLA).**](https://forms.gle/SjXadmUcVwh6NrU68)

- Don’t change public API lightly; avoid it if possible, and include your reasoning in the PR if essential. It causes pain for developers who use Embrace and sometimes runtime errors.
- Get working code on a personal branch with tests before you submit a PR.
- Don't introduce new dependencies or major new functionality.
Our code of conduct applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants.

## Reporting issues
## **Have a feature request or idea?**

If you have any trouble to start contributing, please [contact us directly](mailto:support@embrace.io) or reach out in our [Community Slack](https://embraceio-community.slack.com/)
Finally, feel free to open a [new issue](https://github.com/embrace-io/embrace-android-sdk/issues/new).
Many great ideas for new features come from the community, and we'd be happy to consider yours!

[1]: https://embrace.io/
To share your idea or request, [open a GitHub Issue](https://github.com/embrace-io/embrace-android-sdk/issues/new/choose) using the dedicated issue template.

## **Found a bug?**

For urgent matters (such as outages) or issues concerning the Embrace service or UI, please email [support@embrace.io](mailto:support@embrace.io) or reach out in our [Community Slack](https://join.slack.com/t/embraceio-community/shared_invite/zt-ywr4jhzp-DLROX0ndN9a0soHMf6Ksow) for direct, faster assistance.

You may submit a bug report concerning the Embrace iOS SDK by [opening a GitHub Issue](https://github.com/embrace-io/embrace-android-sdk/issues/new/choose). Use the appropriate template and provide all the listed details to help us resolve the issue.

## **Have a patch?**

We welcome all code contributions to the library. If you have a patch adding value to the SDK, let us know!

If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.

At a minimum, to be accepted and merged, Pull Requests must:

- Have a stated goal and a detailed description of the changes made.
- Include thorough test coverage and documentation, where applicable.
- Pass all tests and code quality checks on CI.
- Receive at least one approval from a project member with push permissions.

Make sure that your code is readable, well-encapsulated, and follows existing code and naming conventions. Any suppression of lint violations must be done in code and properly explained. The PR should comprise commits that are reasonably small with proper commit messages.

## Questions?

You can reach us at [support@embrace.io](mailto:support@embrace.io) or in our [Community Slack](https://join.slack.com/t/embraceio-community/shared_invite/zt-ywr4jhzp-DLROX0ndN9a0soHMf6Ksow).

0 comments on commit 16085cf

Please sign in to comment.