diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f395bb..e2e55ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,55 +4,30 @@ Thank you for your interest in contributing to the Ice Builder for Gradle! ## How to Contribute -Follow these steps to contribute code or documentation to this project: +To contribute code or documentation to this project, please follow these steps: -1. Download and review carefully our [Contributor Agreement](https://zeroc.com/download/ZeroCContributorAgreement.pdf), and send us a completed and signed copy. +1. Review the [ZeroC Contributor Agreement](https://gist.github.com/zcabot/1a4c24dca55adaa83d78cdeabc63226b). + The CLA assistant bot will ask you to sign this agreement when you submit + your first pull request. - Please sign this agreement with a pen, as we do not accept electronic signatures.
- Then email a scanned copy of this agreement to contributing@zeroc.com, or send us an original paper copy by [snail mail](https://zeroc.com/about.html#contact). - - You need to do this only once, before your first contribution. - -2. For large contributions (see below), make sure to first discuss your ideas with the [community](https://forums.zeroc.com) or by sending us an email. +2. If you're planning to make a significant contribution, such as a new feature + or major changes, please discuss your ideas with the community first by + starting a [discussion](https://github.com/zeroc-ice/ice-builder-gradle/discussions) or by + contacting us via [email](mailto:contributing@zeroc.com). 3. Fork this repository. -4. Follow this project's naming and coding conventions when implementing your contribution - we want to keep all our source code consistent. - -5. Update the test suite if appropriate for your contribution. - -6. Submit a pull request. - -We review carefully any contribution that we accept, and these reviews may take some time. Please keep in mind there is no guarantee your contribution will be accepted: we may reject a pull request for any reason, or no reason. - -## Our Favorite Contributions - -We prefer small contributions as they are easier to review and integrate. If you want to contribute but don't know where to start, consider one of these areas: - - * New sample programs (in the [ice-demos](https://github.com/zeroc-ice/ice-demos) repository) - - * Small bug fixes that affect only one or a few source files - - * Fixes for the documentation - - * Ports to new platforms and compilers - -## Large Contributions - -Please don't spend weeks or months on a new feature without checking with us first! - -Some contributions are troublesome and therefore difficult to accept: - - * New features that require a new version of the Ice encoding or Ice protocol
- For example, adding a new Slice type would most likely require a new version of the Ice encoding +4. When implementing your contribution, please adhere to the project's naming + and coding conventions to maintain consistency in the source code. - * New features that may be useful for your project but are not obviously useful to other projects
- We want to keep our software lean and focused! +5. Submit a pull request. - * Any update that breaks source compatibility with the most recent release +We review carefully any contribution that we accept, and these reviews may take +some time. Please keep in mind there is no guarantee your contribution will be +accepted: we may reject a pull request for any reason, or no reason. ## Contact - * Community Forums: https://forums.zeroc.com - * Twitter: https://twitter.com/zeroc - * Email: contributing@zeroc.com +- GitHub Discussions: +- Twitter: +- Email: