[CCI] update contributing.md #3794
Conversation
Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>
Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>
…ch-Dashboards into update-contributing-guide
Signed-off-by: Alexei Karikov <karikov.alist.ru@gmail.com>
There was a problem hiding this comment.
@Nicksqain Thanks so much, there's a lot of great stuff here! The challenge is to make sure we get the right material in the right places, where it will have the biggest impact.
This PR currently adds information about:
- Claiming good first issues
- Additional DCO guidance
- First pull request/git basics guide
- How to use the CHANGELOG
Each of these is valuable, but we'll probably want to handle them all separately. One important thing to note is that this CONTRIBUTING.md file is not unique to OpenSearch Dashboards. It's derived from https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md in the community repository for the OpenSearch project. Many of the suggestions here are applicable to any OpenSearch project, and not specific to OpenSearch Dashboards.
For the good first issue instructions, open a PR against https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md, and move them from the Bug Reports section to the Contributing Code section.
For the DCO changes, start with looking at whether there's anything missing from the DCO instructions in that file and open a PR against https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md as needed.
The https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md file is also where you should open a separate PR for the CHANGELOG guidance. Note that there's currently an ongoing effort to improve our changelog processes, so you may be interested in reading opensearch-project/.github#148 to see how it may affect contributors.
Once we've merged changes to https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md, we can make a PR to also merge them into this file, too.
Finally, the first pull request instructions would probably be best as a new section at the bottom of https://github.com/opensearch-project/.github/blob/main/ONBOARDING.md.
I did make some inline suggestions, but I'm going to set this as a draft for now. We can come back to it after the other PRs to the .github repository are complete.
| _Note_: Since you are a beginner, we advise you to start with simple issues. | ||
|
|
||
| For this there is a special label "<font color="SlateBlue">**Good first issue**</font>" | ||
|
|
||
| Warning! If you have selected an issue and want to get started, check if the issue is free. If for it has already been assigned <br> and there is no pull request for a long time, ask that user using @ (e.g @nickname) if he/she is willing to concede to you. | ||
|
|
||
| If the issue has recently been created and there are no appointees, then feel free to write in a comment that you are ready to take on the issue. | ||
|
|
||
| Feel free to create an issue if you have not been able to work out the installation, or a bug within the project. Also feel free to ask on the issue page if you are solving a problem but can't figure out the structure of the project. | ||
|
|
There was a problem hiding this comment.
This whole topic should be moved to the "Contributing Code" section. The idea is that opening and participating in issues is one type of contribution, separate from providing code.
| @@ -41,6 +46,16 @@ As with other types of contributions, the first step is to [**open an issue on G | |||
|
|
|||
| Once you've opened an issue, check out our [Developer Guide](./DEVELOPER_GUIDE.md) for instructions on how to get started. | |||
|
|
|||
| _Note_: Since you are a beginner, we advise you to start with simple issues. | |||
There was a problem hiding this comment.
Not all readers of this document are beginners. We should rephrase to be something like, "The easiest way to get started is with simple issues".
| @@ -41,6 +46,16 @@ As with other types of contributions, the first step is to [**open an issue on G | |||
|
|
|||
| Once you've opened an issue, check out our [Developer Guide](./DEVELOPER_GUIDE.md) for instructions on how to get started. | |||
|
|
|||
| _Note_: Since you are a beginner, we advise you to start with simple issues. | |||
|
|
|||
| For this there is a special label "<font color="SlateBlue">**Good first issue**</font>" | |||
There was a problem hiding this comment.
I think GitHub will render a label link as the link itself.
| For this there is a special label "<font color="SlateBlue">**Good first issue**</font>" | |
| For this there is a special label https://github.com/opensearch-project/OpenSearch-Dashboards/labels/good%20first%20issue |
|
|
||
| For this there is a special label "<font color="SlateBlue">**Good first issue**</font>" | ||
|
|
||
| Warning! If you have selected an issue and want to get started, check if the issue is free. If for it has already been assigned <br> and there is no pull request for a long time, ask that user using @ (e.g @nickname) if he/she is willing to concede to you. |
There was a problem hiding this comment.
| Warning! If you have selected an issue and want to get started, check if the issue is free. If for it has already been assigned <br> and there is no pull request for a long time, ask that user using @ (e.g @nickname) if he/she is willing to concede to you. | |
| Warning! Before getting started, check if the issue is free. If it has already been assigned for a long time and there isn't a pull request yet, ask the assigned user using @ (e.g @nickname) if you can work on it instead. |
|
|
||
| Warning! If you have selected an issue and want to get started, check if the issue is free. If for it has already been assigned <br> and there is no pull request for a long time, ask that user using @ (e.g @nickname) if he/she is willing to concede to you. | ||
|
|
||
| If the issue has recently been created and there are no appointees, then feel free to write in a comment that you are ready to take on the issue. |
There was a problem hiding this comment.
| If the issue has recently been created and there are no appointees, then feel free to write in a comment that you are ready to take on the issue. | |
| If the issue has no assignees, then feel free to write in a comment that you are ready to take on the issue. |
| You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `--signoff` to add the `Signed-off-by` line to the end of the commit message. | ||
|
|
||
| Fill in your personal details as well as an email that is public on github: |
There was a problem hiding this comment.
| Fill in your personal details as well as an email that is public on github: | |
| Configure `git` with your name and an email that is public on github: |
| git config user.email "MY_NAME@example.com" | ||
| ``` | ||
|
|
||
| ## First pull request |
There was a problem hiding this comment.
This section should be a separate document. Because it's generic, I'd suggest proposing a new document in https://github.com/opensearch-project/.github
Description
CONTRIBUTING.md update:
The way I see it, this PR should help newbies who don't know how to work with git. It raises the entry threshold. This is the reference to #6948.
Issues Resolved
#6845
Check List
yarn test:jestyarn test:jest_integrationyarn test:ftr