You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by fr...@apache.org on 2022/11/12 01:57:42 UTC
[calcite] branch main updated: [CALCITE-5353] Document new procedure for requesting JIRA accounts and becoming a contributor
This is an automated email from the ASF dual-hosted git repository.
francischuang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/calcite.git
The following commit(s) were added to refs/heads/main by this push:
new 7277e53ade [CALCITE-5353] Document new procedure for requesting JIRA accounts and becoming a contributor
7277e53ade is described below
commit 7277e53adea98e7dd8477d5a47e728aca6d8f680
Author: Francis Chuang <fr...@apache.org>
AuthorDate: Tue Nov 1 10:09:15 2022 +1100
[CALCITE-5353] Document new procedure for requesting JIRA accounts and becoming a contributor
---
README.md | 3 ++
site/_docs/howto.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++
site/develop/index.md | 59 +++++++++++++++++++++++++++++++++++---
3 files changed, 136 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 64a9145ea6..af6a60e2da 100644
--- a/README.md
+++ b/README.md
@@ -35,3 +35,6 @@ Elasticsearch, MongoDB, Kafka, and others, with minimal
configuration.
For more details, see the [home page](http://calcite.apache.org).
+
+The project uses [JIRA](https://issues.apache.org/jira/browse/CALCITE)
+for issue tracking. For further information, please see the [JIRA accounts guide](https://calcite.apache.org/develop/#jira-accounts).
diff --git a/site/_docs/howto.md b/site/_docs/howto.md
index 2b2a0a950e..921a962ce9 100644
--- a/site/_docs/howto.md
+++ b/site/_docs/howto.md
@@ -1006,3 +1006,81 @@ that `main` code freeze is over and commits can resume.
See instructions in
[site/README.md]({{ site.sourceRoot }}/site/README.md).
+
+# Advanced topics for PMC members
+
+## Processing JIRA account requests
+Here are some email templates that can be used when processing requests for JIRA accounts.
+
+### Account added to contributor list
+{% highlight text %}
+Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! I have added your username ([INSERT USERNAME HERE])
+to the contributors group in JIRA. Happy contributing!
+
+If you have not subscribed to our development list (dev@calcite.apache.org) yet, I encourage you to do so by
+emailing dev-subscribe@calcite.apache.org. Further information about our mailing lists is available here:
+https://calcite.apache.org/community/#mailing-lists
+
+Best regards,
+[INSERT YOUR NAME HERE]
+{% endhighlight %}
+
+### Account not found
+{% highlight text %}
+Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! I am sorry to inform you that I was unable to
+find your account ([INSERT USERNAME HERE]) in JIRA and was not able to add you to the contributors group.
+Please let me know the correct username by return email and I will process your request again.
+
+If you do not have an ASF JIRA account, please follow the instructions here to request one:
+https://calcite.apache.org/develop/#i-do-not-have-an-asf-jira-account-want-to-request-an-account-and-be-added-as-a-contributor
+
+Best regards,
+[INSERT YOUR NAME HERE]
+{% endhighlight %}
+
+### JIRA account created and added to contributors list
+{% highlight text %}
+Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! I have requested for your JIRA account
+with the username ([INSERT USERNAME HERE]) to be created. You will receive an email shortly with further
+instructions on how to set your password. I have also added your account to the contributors list in JIRA.
+Happy contributing!
+
+If you have not subscribed to our development list (dev@calcite.apache.org) yet, I encourage you to do so by
+emailing dev-subscribe@calcite.apache.org. Further information about our mailing lists is available here:
+https://calcite.apache.org/community/#mailing-lists
+
+Best regards,
+[INSERT YOUR NAME HERE]
+{% endhighlight %}
+
+### JIRA username unavailable
+{% highlight text %}
+Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! Unfortunately, the username you requested
+([INSERT USERNAME HERE]) is not available. Please note that usernames can only contain lowercase
+letters and numbers. Please select a different username and let me know by return email to try again.
+
+Best regards,
+[INSERT YOUR NAME HERE]
+{% endhighlight %}
+
+### Request not sent from same email address for JIRA account
+{% highlight text %}
+Hello [INSERT NAME HERE],
+
+Thanks for your interest in becoming a Calcite contributor! Unfortunately, I am unable to process your
+request as the request was not sent from the email address to be linked to your JIRA account.
+
+Please send your request again using the same email address as the one requested for your account ([INSERT EMAIL ADDRESS HERE]),
+so that I can process your request.
+
+Best regards,
+[INSERT YOUR NAME HERE]
+{% endhighlight %}
diff --git a/site/develop/index.md b/site/develop/index.md
index a58b8f138c..d79f0155da 100644
--- a/site/develop/index.md
+++ b/site/develop/index.md
@@ -65,6 +65,57 @@ The HOWTO describes how to
[run more or fewer tests]({{ site.baseurl }}/docs/howto.html#running-tests) and
[run integration tests]({{ site.baseurl }}/docs/howto.html#running-integration-tests).
+## JIRA accounts
+Calcite uses [JIRA](https://issues.apache.org/jira/browse/CALCITE) for issues/case management.
+You must have a JIRA account in order to log cases and issues.
+
+### I already have an ASF JIRA account and want to be added as a contributor
+If you already have an ASF JIRA account, you do not need to sign up for a
+new account. Please email [jira-requests@calcite.apache.org](mailto:jira-requests@calcite.apache.org)
+using the following template, so that we can add your account to the
+contributors list in JIRA:
+
+[**[Open the template in your email client]**](mailto:jira-requests@calcite.apache.org?subject=Add%20me%20as%20a%20contributor%20to%20JIRA&body=Hello,%0A%0APlease%20add%20me%20as%20a%20contributor%20to%20JIRA.%0AMy%20JIRA%20username%20is:%20[INSERT%20YOUR%20JIRA%20USERNAME%20HERE]%0A%0AThanks,%0A[INSERT%20YOUR%20NAME%20HERE])
+{% highlight text %}
+Subject: Add me as a contributor to JIRA
+
+Hello,
+
+Please add me as a contributor to JIRA.
+My JIRA username is: [INSERT YOUR JIRA USERNAME HERE]
+
+Thanks,
+[INSERT YOUR NAME HERE]
+{% endhighlight %}
+
+
+### I do not have an ASF JIRA account, want to request an account and be added as a contributor
+In order to request an ASF JIRA account, you will need to email
+[jira-requests@calcite.apache.org](mailto:jira-requests@calcite.apache.org)
+using the following template:
+
+[**[Open the template in your email client]**](mailto:jira-requests@calcite.apache.org?subject=Request%20for%20JIRA%20Account&body=Hello,%0A%0AI%20would%20like%20to%20request%20a%20JIRA%20account.%0AMy%20proposed%20JIRA%20username:%20[INSERT%20YOUR%20DESIRED%20JIRA%20USERNAME%20HERE%20(LOWERCASE%20LETTERS%20AND%20NUMBERS%20ONLY)]%0AMy%20full%20name:%20[INSERT%20YOUR%20FULL%20NAME%20HERE]%0AMy%20email%20address:%20[INSERT%20YOUR%20EMAIL%20ADDRESS%20HERE]%0A%0AThanks,%0A[INSERT%20YOUR%20NA [...]
+{% highlight text %}
+Subject: Request for JIRA Account
+
+Hello,
+
+I would like to request a JIRA account.
+My proposed JIRA username: [INSERT YOUR DESIRED JIRA USERNAME HERE (LOWERCASE LETTERS AND NUMBERS ONLY)]
+My full name: [INSERT YOUR FULL NAME HERE]
+My email address: [INSERT YOUR EMAIL ADDRESS HERE]
+
+Thanks,
+[INSERT YOUR NAME HERE]
+{% endhighlight %}
+
+**IMPORTANT**: The email address the request is sent from MUST be the same
+as the email address in the body of the request, otherwise, we will not be
+able to process your request.
+
+Once the ASF has processed our submission on your behalf, you will receive
+an email to set your password.
+
## Contributing
We welcome contributions.
@@ -88,7 +139,7 @@ summary line. If you remove information while clarifying, put it in
the description of the case.
Design discussions may happen in various places (email threads,
-github reviews) but the JIRA case is the canonical place for those
+Github reviews) but the JIRA case is the canonical place for those
discussions. Link to them or summarize them in the case.
When implementing a case, especially a new feature, make sure
@@ -112,8 +163,8 @@ feel free to tag the respective contributor(s) in the discussion.
If you are going to take on the issue right away assign it to yourself.
To assign issues to yourself you have to be registered in JIRA as a contributor.
-In order to do that, send an email to the developers list
-and provide your JIRA username.
+In order to do that, please follow the instructions outlined in the
+[JIRA Accounts](#jira-accounts) section.
If you are committed to fixing the issue before the upcoming release set
the fix version accordingly (e.g., 1.20.0), otherwise leave it as blank.
@@ -307,7 +358,7 @@ so it is better to stick with `org.checkerframework.checker.nullness.qual.Nullab
String value = holder.get();
}
-## Continuous Integration Testing
+## Continuous integration testing
Calcite exploits [GitHub actions](https://github.com/apache/calcite/actions?query=branch%3Amain) for continuous
integration testing.