-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5e544d2
Showing
10 changed files
with
496 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
#cpp code owners | ||
cpp/ @rapidsai/<repo>-cpp-codeowners | ||
|
||
#python code owners | ||
python/ @rapidsai/<repo>-python-codeowners | ||
python/dask_cudf/ @rapidsai/<repo>-dask-codeowners | ||
|
||
#cmake code owners | ||
**/CMakeLists.txt @rapidsai/<repo>-cmake-codeowners | ||
**/cmake/ @rapidsai/<repo>-cmake-codeowners | ||
|
||
#build/ops code owners | ||
.github/ @rapidsai/ops-codeowners | ||
ci/ @rapidsai/ops-codeowners | ||
conda/ @rapidsai/ops-codeowners | ||
**/Dockerfile @rapidsai/ops-codeowners | ||
**/.dockerignore @rapidsai/ops-codeowners | ||
docker/ @rapidsai/ops-codeowners |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Bug report | ||
about: Create a bug report to help us improve ___PROJECT___ | ||
title: "[BUG]" | ||
labels: "? - Needs Triage, bug" | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**Steps/Code to reproduce bug** | ||
Follow this guide http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports to craft a minimal bug report. This helps us reproduce the issue you're having and resolve the issue more quickly. | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Environment details (please complete the following information):** | ||
- Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)] | ||
- Method of ___PROJECT___ install: [conda, Docker, or from source] | ||
- If method of install is [Docker], provide `docker pull` & `docker run` commands used | ||
|
||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
name: Documentation request | ||
about: Report incorrect or needed documentation | ||
title: "[DOC]" | ||
labels: "? - Needs Triage, doc" | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Report incorrect documentation | ||
|
||
**Location of incorrect documentation** | ||
Provide links and line numbers if applicable. | ||
|
||
**Describe the problems or issues found in the documentation** | ||
A clear and concise description of what you found to be incorrect. | ||
|
||
**Steps taken to verify documentation is incorrect** | ||
List any steps you have taken: | ||
|
||
**Suggested fix for documentation** | ||
Detail proposed changes to fix the documentation if you have any. | ||
|
||
--- | ||
|
||
## Report needed documentation | ||
|
||
**Report needed documentation** | ||
A clear and concise description of what documentation you believe it is needed and why. | ||
|
||
**Describe the documentation you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Steps taken to search for needed documentation** | ||
List any steps you have taken: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for ___PROJECT___ | ||
title: "[FEA]" | ||
labels: "? - Needs Triage, feature request" | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I wish I could use ___PROJECT___ to do [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context, code examples, or references to existing implementations about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Submit question | ||
about: Ask a general question about ___PROJECT___ | ||
title: "[QST]" | ||
labels: "? - Needs Triage, question" | ||
assignees: '' | ||
|
||
--- | ||
|
||
**What is your question?** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<!-- | ||
Thank you for contributing to ___PROJECT___ :) | ||
Here are some guidelines to help the review process go smoothly. | ||
1. Please write a description in this text box of the changes that are being | ||
made. | ||
2. Please ensure that you have written units tests for the changes made/features | ||
added. | ||
3. If you are closing an issue please use one of the automatic closing words as | ||
noted here: https://help.github.com/articles/closing-issues-using-keywords/ | ||
4. If your pull request is not ready for review but you want to make use of the | ||
continuous integration testing facilities please label it with `[WIP]`. | ||
5. If your pull request is ready to be reviewed without requiring additional | ||
work on top of it, then remove the `[WIP]` label (if present) and replace | ||
it with `[REVIEW]`. If assistance is required to complete the functionality, | ||
for example when the C/C++ code of a feature is complete but Python bindings | ||
are still required, then add the label `[HELP-REQ]` so that others can triage | ||
and assist. The additional changes then can be implemented on top of the | ||
same PR. If the assistance is done by members of the rapidsAI team, then no | ||
additional actions are required by the creator of the original PR for this, | ||
otherwise the original author of the PR needs to give permission to the | ||
person(s) assisting to commit to their personal fork of the project. If that | ||
doesn't happen then a new PR based on the code of the original PR can be | ||
opened by the person assisting, which then will be the PR that will be | ||
merged. | ||
6. Once all work has been done and review has taken place please do not add | ||
features or make changes out of the scope of those requested by the reviewer | ||
(doing this just add delays as already reviewed code ends up having to be | ||
re-reviewed/it is hard to tell what is new etc!). Further, please do not | ||
rebase your branch on main/force push/rewrite history, doing any of these | ||
causes the context of any comments made by reviewers to be lost. If | ||
conflicts occur against main they should be resolved by merging main | ||
into the branch used for making the pull request. | ||
Many thanks in advance for your cooperation! | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# ___PROJECT___ 0.0.0 (DD Mon YYYY) | ||
|
||
## New Features | ||
|
||
- ... | ||
|
||
## Improvements | ||
|
||
- ... | ||
|
||
## Bug Fixes | ||
|
||
- ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing to ___PROJECT___ | ||
|
||
If you are interested in contributing to ___PROJECT___, your contributions will fall | ||
into three categories: | ||
1. You want to report a bug, feature request, or documentation issue | ||
- File an [issue](https://github.com/rapidsai/___PROJECT___/issues/new/choose) | ||
describing what you encountered or what you want to see changed. | ||
- The RAPIDS team will evaluate the issues and triage them, scheduling | ||
them for a release. If you believe the issue needs priority attention | ||
comment on the issue to notify the team. | ||
2. You want to propose a new Feature and implement it | ||
- Post about your intended feature, and we shall discuss the design and | ||
implementation. | ||
- Once we agree that the plan looks good, go ahead and implement it, using | ||
the [code contributions](#code-contributions) guide below. | ||
3. You want to implement a feature or bug-fix for an outstanding issue | ||
- Follow the [code contributions](#code-contributions) guide below. | ||
- If you need more context on a particular issue, please ask and we shall | ||
provide. | ||
|
||
## Code contributions | ||
|
||
### Your first issue | ||
|
||
1. Read the project's [README.md](https://github.com/rapidsai/___PROJECT___/blob/main/README.md) | ||
to learn how to setup the development environment | ||
2. Find an issue to work on. The best way is to look for the [good first issue](https://github.com/rapidsai/___PROJECT___/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | ||
or [help wanted](https://github.com/rapidsai/___PROJECT___/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels | ||
3. Comment on the issue saying you are going to work on it | ||
4. Code! Make sure to update unit tests! | ||
5. When done, [create your pull request](https://github.com/rapidsai/___PROJECT___/compare) | ||
6. Verify that CI passes all [status checks](https://help.github.com/articles/about-status-checks/). Fix if needed | ||
7. Wait for other developers to review your code and update code as needed | ||
8. Once reviewed and approved, a RAPIDS developer will merge your pull request | ||
|
||
Remember, if you are unsure about anything, don't hesitate to comment on issues | ||
and ask for clarifications! | ||
|
||
### Seasoned developers | ||
|
||
Once you have gotten your feet wet and are more comfortable with the code, you | ||
can look at the prioritized issues of our next release in our [project boards](https://github.com/rapidsai/___PROJECT___/projects). | ||
|
||
> **Pro Tip:** Always look at the release board with the highest number for | ||
issues to work on. This is where RAPIDS developers also focus their efforts. | ||
|
||
Look at the unassigned issues, and find an issue you are comfortable with | ||
contributing to. Start with _Step 3_ from above, commenting on the issue to let | ||
others know you are working on it. If you have any questions related to the | ||
implementation of the issue, ask them in the issue instead of the PR. | ||
|
||
## Attribution | ||
Portions adopted from https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md |
Oops, something went wrong.