Skip to content

Commit cffcc02

Browse files
Update CONTRIBUTING.md
1 parent b7ce220 commit cffcc02

File tree

1 file changed

+17
-42
lines changed

1 file changed

+17
-42
lines changed

CONTRIBUTING.md

+17-42
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,30 @@ Thank you for your interest in contributing to the Ice Builder for Gradle!
44

55
## How to Contribute
66

7-
Follow these steps to contribute code or documentation to this project:
7+
To contribute code or documentation to this project, please follow these steps:
88

9-
1. Download and review carefully our [Contributor Agreement](https://zeroc.com/download/ZeroCContributorAgreement.pdf), and send us a completed and signed copy.
9+
1. Review the [ZeroC Contributor Agreement](https://gist.github.com/zcabot/1a4c24dca55adaa83d78cdeabc63226b).
10+
The CLA assistant bot will ask you to sign this agreement when you submit
11+
your first pull request.
1012

11-
Please sign this agreement with a pen, as we do not accept electronic signatures.<br/>
12-
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).
13-
14-
You need to do this only once, before your first contribution.
15-
16-
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.
13+
2. If you're planning to make a significant contribution, such as a new feature
14+
or major changes, please discuss your ideas with the community first by
15+
starting a [discussion](https://github.com/zeroc-ice/ice-builder-gradle/discussions) or by
16+
contacting us via [email](mailto:contributing@zeroc.com).
1717

1818
3. Fork this repository.
1919

20-
4. Follow this project's naming and coding conventions when implementing your contribution - we want to keep all our source code consistent.
21-
22-
5. Update the test suite if appropriate for your contribution.
23-
24-
6. Submit a pull request.
25-
26-
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.
27-
28-
## Our Favorite Contributions
29-
30-
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:
31-
32-
* New sample programs (in the [ice-demos](https://github.com/zeroc-ice/ice-demos) repository)
33-
34-
* Small bug fixes that affect only one or a few source files
35-
36-
* Fixes for the documentation
37-
38-
* Ports to new platforms and compilers
39-
40-
## Large Contributions
41-
42-
Please don't spend weeks or months on a new feature without checking with us first!
43-
44-
Some contributions are troublesome and therefore difficult to accept:
45-
46-
* New features that require a new version of the Ice encoding or Ice protocol<br/>
47-
For example, adding a new Slice type would most likely require a new version of the Ice encoding
20+
4. When implementing your contribution, please adhere to the project's naming
21+
and coding conventions to maintain consistency in the source code.
4822

49-
* New features that may be useful for your project but are not obviously useful to other projects<br/>
50-
We want to keep our software lean and focused!
23+
5. Submit a pull request.
5124

52-
* Any update that breaks source compatibility with the most recent release
25+
We review carefully any contribution that we accept, and these reviews may take
26+
some time. Please keep in mind there is no guarantee your contribution will be
27+
accepted: we may reject a pull request for any reason, or no reason.
5328

5429
## Contact
5530

56-
* Community Forums: https://forums.zeroc.com
57-
* Twitter: https://twitter.com/zeroc
58-
* Email: contributing@zeroc.com
31+
- GitHub Discussions: <https://github.com/zeroc-ice/ice-builder-gradle/discussions>
32+
- Twitter: <https://twitter.com/zeroc>
33+
- Email: <contributing@zeroc.com>

0 commit comments

Comments
 (0)