You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/12/02 16:59:19 UTC
[GitHub] [arrow] thisisnic commented on a change in pull request #11807: ARROW-14715: [Doc] Steps in making your first PR - finding issues
thisisnic commented on a change in pull request #11807:
URL: https://github.com/apache/arrow/pull/11807#discussion_r761262715
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
Review comment:
```suggestion
You have successfully built the Arrow library; congrats!
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
+you might already have a bug to fix in mind, or a new feature that you want to implement.
+Or you still need an issue to work on and you need some help with finding one.
+
+For both cases JIRA is the issue tracker we use.
+
+First we will explain how to use JIRA if you have a fix or a feature to work on but
+there is no issue about it created. In that case you need to create an issue yourself.
Review comment:
```suggestion
First we will explain how to use JIRA if you have a fix or a feature to work on that doesn't yet have a JIRA ticket open, in which case you will need to create a JIRA ticket yourself.
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
+you might already have a bug to fix in mind, or a new feature that you want to implement.
+Or you still need an issue to work on and you need some help with finding one.
+
+For both cases JIRA is the issue tracker we use.
Review comment:
```suggestion
For both cases, JIRA is the issue tracker that we use.
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
Review comment:
```suggestion
The next step is finding something to work on. As mentioned before,
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
+you might already have a bug to fix in mind, or a new feature that you want to implement.
+Or you still need an issue to work on and you need some help with finding one.
+
+For both cases JIRA is the issue tracker we use.
+
+First we will explain how to use JIRA if you have a fix or a feature to work on but
+there is no issue about it created. In that case you need to create an issue yourself.
+
+Secondly we will show a way to find good first issues.
Review comment:
```suggestion
Secondly, we will show you a way to find good first issues to work on.
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
+you might already have a bug to fix in mind, or a new feature that you want to implement.
+Or you still need an issue to work on and you need some help with finding one.
+
+For both cases JIRA is the issue tracker we use.
+
+First we will explain how to use JIRA if you have a fix or a feature to work on but
+there is no issue about it created. In that case you need to create an issue yourself.
+
+Secondly we will show a way to find good first issues.
+
+How to create a JIRA issue
+==========================
+
+First thing you need to do is to make an account on the ASF JIRA following
+`this link <https://issues.apache.org/jira/secure/Signup!default.jspa>`_. You will have to
+select your language and choose an avatar. If the registration is successful you will see:
+
+.. figure:: jira_1.jpeg
+ :scale: 70 %
+ :alt: creating an ASF JIRA account
+
+ The window you get after creating an account on the ASF JIRA.
+
+Here you can click **Create an issue** and select **Apache Arrow project** and **Type** of
+the issue (Bug, Feature, …).
+
+.. figure:: jira_2.jpeg
+ :scale: 70 %
+ :alt: creating JIRA issue
+
+ The window to create a JIRA issue.
+
+You are ready to create the issue! Add a title and a description following the :ref:`tips for using JIRA <jira-tips> and you are ready to go!
+
+.. seealso::
+ :ref:`Tips for using JIRA <jira-tips>`
+
+You don’t need any special permissions on JIRA to be able to create issues.
+Once you are more involved in the project and want to do more on JIRA, for example assigning
+yourself an issue, you will need “Contributor” permissions. To get this role, ask on the
+mailing list or in the comment of the JIRA issue you created.
+
+When the ticket is created you can start a discussion about it in the JIRA comments section.
+
+How we use JIRA to find an issue
+================================
+
+To make it easier to find issues that are suited for a new contributor we added labels
+like “good-first-issue” or “beginner”.
Review comment:
```suggestion
To make it easier for you to find issues that are well-suited for new contributors, we have added labels
like “good-first-issue” or “beginner” to some JIRA tickets.
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
+you might already have a bug to fix in mind, or a new feature that you want to implement.
+Or you still need an issue to work on and you need some help with finding one.
+
+For both cases JIRA is the issue tracker we use.
+
+First we will explain how to use JIRA if you have a fix or a feature to work on but
+there is no issue about it created. In that case you need to create an issue yourself.
+
+Secondly we will show a way to find good first issues.
+
+How to create a JIRA issue
+==========================
+
+First thing you need to do is to make an account on the ASF JIRA following
+`this link <https://issues.apache.org/jira/secure/Signup!default.jspa>`_. You will have to
+select your language and choose an avatar. If the registration is successful you will see:
+
+.. figure:: jira_1.jpeg
+ :scale: 70 %
+ :alt: creating an ASF JIRA account
+
+ The window you get after creating an account on the ASF JIRA.
+
+Here you can click **Create an issue** and select **Apache Arrow project** and **Type** of
+the issue (Bug, Feature, …).
+
+.. figure:: jira_2.jpeg
+ :scale: 70 %
+ :alt: creating JIRA issue
+
+ The window to create a JIRA issue.
+
+You are ready to create the issue! Add a title and a description following the :ref:`tips for using JIRA <jira-tips> and you are ready to go!
+
+.. seealso::
+ :ref:`Tips for using JIRA <jira-tips>`
+
+You don’t need any special permissions on JIRA to be able to create issues.
+Once you are more involved in the project and want to do more on JIRA, for example assigning
+yourself an issue, you will need “Contributor” permissions. To get this role, ask on the
+mailing list or in the comment of the JIRA issue you created.
+
+When the ticket is created you can start a discussion about it in the JIRA comments section.
+
+How we use JIRA to find an issue
+================================
+
+To make it easier to find issues that are suited for a new contributor we added labels
+like “good-first-issue” or “beginner”.
+
+.. seealso::
+ Search for good first/second issues with labels like in the `link here
+ <https://issues.apache.org/jira/browse/ARROW-14659?filter=-4&jql=project%20%3D%20ARROW%20AND%20status%20%3D%20Open%20AND%20labels%20in%20(Beginner%2C%20beginner%2C%20beginners%2C%20beginnner%2C%20beginner-friendly%2C%20good-first-issue%2C%20good-second-issue%2C%20GoodForNewContributors%2C%20newbie%2C%20easyfix%2C%20documentation)%20order%20by%20created%20DESC>`_
+
+The issues labeled as good first issues should take no more than two days or a weekend to
+fix them. Once you dig into the code you may find that the issue is not easy at all - it can
+happen as the label is set when making a triage and the problem could be harder then expected.
+Don't hesitate to write that in the comments.
+
+.. figure:: jira_3.jpeg
+ :scale: 45 %
+ :alt: finding good first JIRA issue
+
+ Example of the list of good first issues.
+
+.. note::
+ When you find a JIRA issue you would work on, please mention your interest in the comment
+ section of that issue. That way we will know you are working on it.
+
+Also do not hesitate to ask questions in the comment section of the issue.
+You can get some pointers about where to start and similar issues already solved.
+
+**Do not forget to create a new branch once you created or chose an issue you will be
+working on!** Follow the instructions in the next section: :ref:`pr_and_github`
Review comment:
```suggestion
**Do not forget to create a new branch once you have created or chosen an issue you will be
working on!** Follow the instructions in the next section: :ref:`pr_and_github`
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
+you might already have a bug to fix in mind, or a new feature that you want to implement.
+Or you still need an issue to work on and you need some help with finding one.
+
+For both cases JIRA is the issue tracker we use.
+
+First we will explain how to use JIRA if you have a fix or a feature to work on but
+there is no issue about it created. In that case you need to create an issue yourself.
+
+Secondly we will show a way to find good first issues.
+
+How to create a JIRA issue
+==========================
+
+First thing you need to do is to make an account on the ASF JIRA following
+`this link <https://issues.apache.org/jira/secure/Signup!default.jspa>`_. You will have to
+select your language and choose an avatar. If the registration is successful you will see:
+
+.. figure:: jira_1.jpeg
+ :scale: 70 %
+ :alt: creating an ASF JIRA account
+
+ The window you get after creating an account on the ASF JIRA.
+
+Here you can click **Create an issue** and select **Apache Arrow project** and **Type** of
+the issue (Bug, Feature, …).
+
+.. figure:: jira_2.jpeg
+ :scale: 70 %
+ :alt: creating JIRA issue
+
+ The window to create a JIRA issue.
+
+You are ready to create the issue! Add a title and a description following the :ref:`tips for using JIRA <jira-tips> and you are ready to go!
+
+.. seealso::
+ :ref:`Tips for using JIRA <jira-tips>`
+
+You don’t need any special permissions on JIRA to be able to create issues.
+Once you are more involved in the project and want to do more on JIRA, for example assigning
+yourself an issue, you will need “Contributor” permissions. To get this role, ask on the
+mailing list or in the comment of the JIRA issue you created.
+
+When the ticket is created you can start a discussion about it in the JIRA comments section.
+
+How we use JIRA to find an issue
+================================
+
+To make it easier to find issues that are suited for a new contributor we added labels
+like “good-first-issue” or “beginner”.
+
+.. seealso::
+ Search for good first/second issues with labels like in the `link here
+ <https://issues.apache.org/jira/browse/ARROW-14659?filter=-4&jql=project%20%3D%20ARROW%20AND%20status%20%3D%20Open%20AND%20labels%20in%20(Beginner%2C%20beginner%2C%20beginners%2C%20beginnner%2C%20beginner-friendly%2C%20good-first-issue%2C%20good-second-issue%2C%20GoodForNewContributors%2C%20newbie%2C%20easyfix%2C%20documentation)%20order%20by%20created%20DESC>`_
+
+The issues labeled as good first issues should take no more than two days or a weekend to
+fix them. Once you dig into the code you may find that the issue is not easy at all - it can
+happen as the label is set when making a triage and the problem could be harder then expected.
Review comment:
```suggestion
The issues labeled as good first issues should take no more than two days or a weekend to
fix them. Once you dig into the code you may find that the issue is not easy at all - this can
happen as the problem could be harder than the person who triaged the ticket expected it to be.
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
+you might already have a bug to fix in mind, or a new feature that you want to implement.
+Or you still need an issue to work on and you need some help with finding one.
+
+For both cases JIRA is the issue tracker we use.
+
+First we will explain how to use JIRA if you have a fix or a feature to work on but
+there is no issue about it created. In that case you need to create an issue yourself.
+
+Secondly we will show a way to find good first issues.
+
+How to create a JIRA issue
+==========================
+
+First thing you need to do is to make an account on the ASF JIRA following
+`this link <https://issues.apache.org/jira/secure/Signup!default.jspa>`_. You will have to
+select your language and choose an avatar. If the registration is successful you will see:
+
+.. figure:: jira_1.jpeg
+ :scale: 70 %
+ :alt: creating an ASF JIRA account
+
+ The window you get after creating an account on the ASF JIRA.
+
+Here you can click **Create an issue** and select **Apache Arrow project** and **Type** of
+the issue (Bug, Feature, …).
+
+.. figure:: jira_2.jpeg
+ :scale: 70 %
+ :alt: creating JIRA issue
+
+ The window to create a JIRA issue.
+
+You are ready to create the issue! Add a title and a description following the :ref:`tips for using JIRA <jira-tips> and you are ready to go!
+
+.. seealso::
+ :ref:`Tips for using JIRA <jira-tips>`
+
+You don’t need any special permissions on JIRA to be able to create issues.
+Once you are more involved in the project and want to do more on JIRA, for example assigning
+yourself an issue, you will need “Contributor” permissions. To get this role, ask on the
+mailing list or in the comment of the JIRA issue you created.
+
+When the ticket is created you can start a discussion about it in the JIRA comments section.
+
+How we use JIRA to find an issue
+================================
+
+To make it easier to find issues that are suited for a new contributor we added labels
+like “good-first-issue” or “beginner”.
+
+.. seealso::
+ Search for good first/second issues with labels like in the `link here
+ <https://issues.apache.org/jira/browse/ARROW-14659?filter=-4&jql=project%20%3D%20ARROW%20AND%20status%20%3D%20Open%20AND%20labels%20in%20(Beginner%2C%20beginner%2C%20beginners%2C%20beginnner%2C%20beginner-friendly%2C%20good-first-issue%2C%20good-second-issue%2C%20GoodForNewContributors%2C%20newbie%2C%20easyfix%2C%20documentation)%20order%20by%20created%20DESC>`_
+
+The issues labeled as good first issues should take no more than two days or a weekend to
+fix them. Once you dig into the code you may find that the issue is not easy at all - it can
+happen as the label is set when making a triage and the problem could be harder then expected.
+Don't hesitate to write that in the comments.
+
+.. figure:: jira_3.jpeg
+ :scale: 45 %
+ :alt: finding good first JIRA issue
+
+ Example of the list of good first issues.
+
+.. note::
+ When you find a JIRA issue you would work on, please mention your interest in the comment
+ section of that issue. That way we will know you are working on it.
+
+Also do not hesitate to ask questions in the comment section of the issue.
Review comment:
```suggestion
Also, do not hesitate to ask questions in the comment section of the issue.
```
##########
File path: docs/source/developers/guide/step_by_step/finding_issues.rst
##########
@@ -29,4 +29,82 @@
****************************
Finding good first issues 🔎
-****************************
\ No newline at end of file
+****************************
+
+You have successfully built Arrow library, congrats!
+
+The next step is finding something to work on. As was mentioned before,
+you might already have a bug to fix in mind, or a new feature that you want to implement.
+Or you still need an issue to work on and you need some help with finding one.
+
+For both cases JIRA is the issue tracker we use.
+
+First we will explain how to use JIRA if you have a fix or a feature to work on but
+there is no issue about it created. In that case you need to create an issue yourself.
+
+Secondly we will show a way to find good first issues.
+
+How to create a JIRA issue
+==========================
+
+First thing you need to do is to make an account on the ASF JIRA following
+`this link <https://issues.apache.org/jira/secure/Signup!default.jspa>`_. You will have to
+select your language and choose an avatar. If the registration is successful you will see:
+
+.. figure:: jira_1.jpeg
+ :scale: 70 %
+ :alt: creating an ASF JIRA account
+
+ The window you get after creating an account on the ASF JIRA.
+
+Here you can click **Create an issue** and select **Apache Arrow project** and **Type** of
+the issue (Bug, Feature, …).
+
+.. figure:: jira_2.jpeg
+ :scale: 70 %
+ :alt: creating JIRA issue
+
+ The window to create a JIRA issue.
+
+You are ready to create the issue! Add a title and a description following the :ref:`tips for using JIRA <jira-tips> and you are ready to go!
+
+.. seealso::
+ :ref:`Tips for using JIRA <jira-tips>`
+
+You don’t need any special permissions on JIRA to be able to create issues.
+Once you are more involved in the project and want to do more on JIRA, for example assigning
+yourself an issue, you will need “Contributor” permissions. To get this role, ask on the
+mailing list or in the comment of the JIRA issue you created.
+
+When the ticket is created you can start a discussion about it in the JIRA comments section.
+
+How we use JIRA to find an issue
+================================
+
+To make it easier to find issues that are suited for a new contributor we added labels
+like “good-first-issue” or “beginner”.
+
+.. seealso::
+ Search for good first/second issues with labels like in the `link here
+ <https://issues.apache.org/jira/browse/ARROW-14659?filter=-4&jql=project%20%3D%20ARROW%20AND%20status%20%3D%20Open%20AND%20labels%20in%20(Beginner%2C%20beginner%2C%20beginners%2C%20beginnner%2C%20beginner-friendly%2C%20good-first-issue%2C%20good-second-issue%2C%20GoodForNewContributors%2C%20newbie%2C%20easyfix%2C%20documentation)%20order%20by%20created%20DESC>`_
+
+The issues labeled as good first issues should take no more than two days or a weekend to
+fix them. Once you dig into the code you may find that the issue is not easy at all - it can
+happen as the label is set when making a triage and the problem could be harder then expected.
+Don't hesitate to write that in the comments.
+
+.. figure:: jira_3.jpeg
+ :scale: 45 %
+ :alt: finding good first JIRA issue
+
+ Example of the list of good first issues.
+
+.. note::
+ When you find a JIRA issue you would work on, please mention your interest in the comment
+ section of that issue. That way we will know you are working on it.
Review comment:
```suggestion
When you find a JIRA issue you would like to work on, please mention your interest in the comment
section of that issue; that way we will know you are working on it.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org