This is an automated email from the ASF dual-hosted git repository. rzo1 pushed a commit to branch 1168 in repository https://gitbox.apache.org/repos/asf/incubator-stormcrawler.git
commit d6f1001489bcc5dbc517e9ccf43f22f8a07a602a Author: Richard Zowalla <[email protected]> AuthorDate: Wed Apr 3 15:29:35 2024 +0200 Fix #1168 - Add a modified version of CONTRIBUTING.md --- CONTRIBUTING.md | 81 ++++++++++++++++++++++++++------------------------------- 1 file changed, 37 insertions(+), 44 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9ad9e8d..e2c22e71 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,66 +1,59 @@ -Contributing to StormCrawler +Contributing to Apache StormCrawler ============================ +Thank you for your intention to contribute to Apache StormCrawler. As an open-source community, we highly appreciate external contributions to our project. + +To make the process smooth for the project *committers* (those who review and accept changes) and *contributors* (those who propose new changes via pull requests), there are a few rules to follow. + +## Contribution Guidelines + We use GitHub Issues and Pull Requests for tracking contributions. We expect participants to adhere to the GitHub Community Guidelines (found at https://help.github.com/articles/github-community-guidelines/ ). -All contributions should have a Developer Certificate of Origin (see below). +### Get Involved + +The Apache StormCrawler project is developed by volunteers and is always looking for new contributors to work on all parts of the project. +Every contribution is welcome and needed to make it better. A contribution can be anything from a small documentation typo fix to a new component. We especially welcome contributions from first-time users. + +#### Mailing Lists + +To get started, please first join the Apache StormCrawler mailing lists: + +#### [email protected] -Developer Certificate of Origin -------------------------------- +This list is for development discussions, patch suggestions, and current issues posted to the issue tracker for the project. -Contributions to this project should conform to the `Developer Certificate -of Origin` as defined at https://developercertificate.org/. +- [Subscribe]([email protected]) +- [Unsubscribe]([email protected]) +- [Archives](https://lists.apache.org/[email protected]) -Commits to this project need to contain the following line to indicate -the submitter accepts the DCO: +#### [email protected] -``` -Signed-off-by: Your Name <[email protected]> -``` +This list follows changes to the project. This list is not for questions. This list is used by git to post changes to the project. If you have questions about any content here, post them to the stormcrawler-dev list above. -If the contributor sets their _user.name_ and _user.email_ as part of the Git -configuration, they can sign the commit automatically with `git commit -s`. +- [Subscribe]([email protected]) +- [Unsubscribe]([email protected]) +- [Archives](https://lists.apache.org/[email protected]) -By contributing in this way, you agree to the terms as follows: -``` -Developer Certificate of Origin -Version 1.1 +#### GitHub Discussions -Copyright (C) 2004, 2006 The Linux Foundation and its contributors. -1 Letterman Drive -Suite D4700 -San Francisco, CA, 94129 +Feel free to use GitHub Discussions to ask any questions you might have when planning your first contribution. -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. +#### Slack Channel +Another way of contacting Apache StormCrawler committers and PMC members is the #stormcrawler Slack channel. This is a great place to meet and get guidance on contributions. -Developer's Certificate of Origin 1.1 +Further details on using the ASF Slack channels and associated expectations can be found at the related [ASF infra page](https://infra.apache.org/slack.html). -By making a contribution to this project, I certify that: +**Note:** The ASF Slack requires an @apache.org email address to join as a full member. Users without an @apache.org email address have to be invited. -(a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or +### Making a Contribution -(b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or +- Create a new issue on GitHub. Please describe the problem or improvement in the body of the issue. For larger issues, please first contact the developer mailing list and describe the problem. +- Next, create a pull request in GitHub. -(c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. +Bigger contributions can eventually only be accepted when an [ICLA, CCLA or software grant](https://www.apache.org/licenses/contributor-agreements.html) is on file. -(d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. -``` +Contributors who have a history of successful participation are invited to join the project as a committer from the PPMC. \ No newline at end of file
