Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructuring Contributing doc [skip ci] #9026

Merged
merged 30 commits into from
Aug 26, 2021
Merged
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
d9ed1ba
doc restructuration
iskode Aug 12, 2021
23ea87c
dependency + build-from-source updates
iskode Aug 13, 2021
0a0b0ab
emphasis on env files
iskode Aug 13, 2021
edf19e9
build-from-source instruction updates
iskode Aug 13, 2021
69eb32a
Merge branch 'contributing-doc' of github.com:iskode/cudf into contri…
iskode Aug 13, 2021
e03693d
Update `Python cudf contributor` title
iskode Aug 13, 2021
ec951fb
workflow paragraph update
iskode Aug 13, 2021
6e1d901
update `Any contributor` title
iskode Aug 13, 2021
45b0169
remove `build` in `dask-cudf` installation paragraph
iskode Aug 13, 2021
f4e9451
Remove `cd $CUDF_HOME` in build-from-source
iskode Aug 13, 2021
1ea8cdb
update other libraries paragraph in build-from-source section
iskode Aug 13, 2021
f8f37db
emphasis on cudf_dev_cuda*.yml
iskode Aug 13, 2021
5900635
Merge branch 'contributing-doc' of github.com:iskode/cudf into contri…
iskode Aug 13, 2021
0cd676a
add step in dask_cudf install
iskode Aug 13, 2021
e68ed18
add kafka and custreamz sections
iskode Aug 17, 2021
f7515cb
add section for each library
iskode Aug 17, 2021
d3073d0
remove `requirements` in cudf installation
iskode Aug 26, 2021
7e167ae
remove folder specification in cudf installation
iskode Aug 26, 2021
2859c1d
remove contributor label in C++ libcudf install instructions
iskode Aug 26, 2021
f804fbe
remove contributor label in dask-cudf install instructions
iskode Aug 26, 2021
df483bf
add `installing` in cudf section title
iskode Aug 26, 2021
e7159b1
reformulate requirement instructions in all subsections
iskode Aug 26, 2021
4d24281
remove language names
iskode Aug 26, 2021
f96e46e
remove contributor label in libcudf_kafka section
iskode Aug 26, 2021
793867a
reorganize C++ libraries' instructions
iskode Aug 26, 2021
98de65a
refactor subsection titles and remove redundant words
iskode Aug 26, 2021
dd93ade
fix typo
iskode Aug 26, 2021
f792bf2
remove $ in all bash codes
iskode Aug 26, 2021
7a628ac
correct cases
iskode Aug 26, 2021
9706118
correct cases
iskode Aug 26, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ $ py.test -v cudf/cudf/tests # run cudf test suite

#### Installing and testing the `dask-cudf` Python library

- Requirements : `C++ libcudf`, `Python cudf`
- First, build the `libcudf` C++ and `cudf` Python libraries following the steps above

- To install in edit/develop mode the `dask-cudf` python package:
```bash
Expand All @@ -166,7 +166,7 @@ $ py.test -v dask_cudf # run dask_cudf test suite

This section provides instructions for building and testing C++ libcudf_kafka. Thus, C++ libcudf_kafka only contributor will be all set after following instructions below:
iskode marked this conversation as resolved.
Show resolved Hide resolved

- Requirements : `C++ libcudf`
- First, build the `libcudf` C++ library following the steps above

```bash
$ cd $CUDF_HOME
Expand All @@ -179,7 +179,7 @@ $./build.sh libcudf_kafka

#### Python cudf-kafka contributors:

- Requirements : `C++ libcudf`, `C++ libcudf_kafka`
- First, build the `libcudf` and `libcudf_kafka` C++ libraries following the steps above

- To install in edit/develop mode the `cudf-kafka` python package:
```bash
Expand All @@ -190,7 +190,7 @@ $ python setup.py develop

#### Python custreamz contributors:

- Requirements : `C++ libcudf`, `C++ libcudf_kafka`, `Python cudf_kafka`
- First, build C++ `libcudf`, C++ `libcudf_kafka`, and Python `cudf_kafka` following the steps above
iskode marked this conversation as resolved.
Show resolved Hide resolved

- To install in edit/develop mode the `custreamz` python package:
```bash
Expand All @@ -207,7 +207,7 @@ $ py.test -v custreamz # run custreamz test suite

#### Java contributors:

- Requirements : `C++ libcudf`
- First, build the `libcudf` C++ library following the steps above

Please refer to [Java README](https://github.com/rapidsai/cudf/blob/branch-21.10/java/README.md)

Expand Down