pulsar-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] sijie commented on a change in pull request #2459: Added Contributing page on website
Date Tue, 28 Aug 2018 05:24:52 GMT
sijie commented on a change in pull request #2459: Added Contributing page on website
URL: https://github.com/apache/incubator-pulsar/pull/2459#discussion_r213187047

 File path: site2/website/contributing.md
 @@ -0,0 +1,250 @@
+The Apache Pulsar community welcomes contributions from anyone with a passion for distributed
systems! Pulsar has many different opportunities for contributions --
+write new examples/tutorials, add new user-facing libraries, write new Pulsar IO connectors,
or participate on the documentation effort.
+We use a review-then-commit workflow in Pulsar for all contributions.
+**For larger contributions or those that affect multiple components:**
+1. **Engage**: We encourage you to work with the Pulsar community on the
+   [Github Issues](https://github.com/apache/incubator-pulsar/issues) and
+   [developer’s mailing list](/contact) to identify
+   good areas for contribution.
+1. **Design:** More complicated contributions will likely benefit from some early discussion
+   order to scope and design them well.
+**For all contributions:**
+1. **Code:** The best part ;-)
+1. **Review:** Submit a pull request with your contribution to our
+   [GitHub Repo](https://github.com/apache/incubator-pulsar). Work with a committer to review
+   iterate on the code, if needed.
+1. **Commit:** Once at least 2 Pulsar committers have approved the pull request, a Pulsar
+    will merge it into the master branch (and potentially backport to stable branches in
case of
+    bug fixes).
+We look forward to working with you!
+## Engage
+### Mailing list(s)
+We discuss design and implementation issues on the [dev@pulsar.incubator.apache.org](mailto:dev@pulsar.incubator.apache.org)
+mailing list, which is archived [here](https://lists.apache.org/list.html?dev@pulsar.apache.org).
+Join by emailing [`dev-subscribe@pulsar.incubator.apache.org`](mailto:dev-subscribe@pulsar.incubator.apache.org).
+If interested, you can also join the other [mailing lists](/contact).
+### Github Issues
+We are using [Github Issues](https://github.com/apache/incubator-pulsar/issues) as the issue
+and project management tool, as well as a way to communicate among a very diverse and distributed
+of contributors. To be able to gather feedback, avoid frustration, and avoid duplicated efforts
+Pulsar related work are being tracked there.
+If you do not already have an Github account, sign up [here](https://github.com/join).
+If a quick [search](https://github.com/apache/incubator-pulsar/issues) doesn’t turn up
an existing
+Github issue for the work you want to contribute, create it. Please discuss your idea with
+committer in Github or, alternatively, on the developer mailing list.
+If there’s an existing Github issue for your intended contribution, please comment about
your intended
+work. Once the work is understood, a committer will assign the issue to you. If an issue
is currently
+assigned, please check with the current assignee before reassigning.
+For moderate or large contributions, you should not start coding or writing a design document
+there is a corresponding Github issue assigned to you for that work. Simple changes, like
fixing typos,
+do not require an associated issue.
+### Online discussions
+We are using [Apache Pulsar Slack channel](https://apache-pulsar.slack.com/) for online discussions.
+You can self-invite yourself by accessing [this link](https://apache-pulsar.herokuapp.com/).
+Slack channels are great for quick questions or discussions on specialized topics. Remember
that we
+strongly encourage communication via the mailing lists, and we prefer to discuss more complex
+by email. Developers should be careful to move or duplicate all the official or useful discussions
+the issue tracking system and/or the dev mailing list.
+## Design
+To avoid potential frustration during the code review cycle, we encourage you to clearly
scope and
+design non-trivial contributions with the BookKeeper community before you start coding.
 Review comment:
   Pulsar community

This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:

With regards,
Apache Git Services

View raw message