Skip to content

Commit 304811b

Browse files
committed
add CONTRIBUTING.md file
1 parent ec4a346 commit 304811b

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

CONTRIBUTING.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# 🌍 Contributing.
2+
3+
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
4+
5+
## 👶 Getting Started!
6+
7+
Ready to contribute? Here's how to set up `rust-data-analysis` for local development.
8+
9+
1. Fork the `rust-data-analysis` repo on GitHub.
10+
1. Clone your fork locally:
11+
12+
```sh
13+
git clone [email protected]:your_name_here/rust-data-analysis.git
14+
```
15+
16+
1. Navigate to the recently created directory:
17+
18+
```sh
19+
cd rust-data-analysis
20+
```
21+
22+
1. Install the main dependencies:
23+
24+
```sh
25+
# Install a Rust toolchain (e.g. nightly):
26+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly
27+
28+
# Install Jupyter Notebook
29+
pip install notebook
30+
31+
# Install evcxr_jupyter
32+
cargo install evcxr_jupyter
33+
evcxr_jupyter --install
34+
```
35+
36+
1. Start Jupyter Notebook:
37+
38+
```sh
39+
jupyter notebook
40+
```
41+
42+
1. Create a branch for local development:
43+
44+
```sh
45+
git checkout -b name-of-your-bugfix-or-feature
46+
```
47+
48+
Now you can make your changes locally.
49+
50+
1. Commit your changes and push your branch to GitHub:
51+
52+
```sh
53+
git add .
54+
git commit -m "Your detailed description of your changes."
55+
git push origin name-of-your-bugfix-or-feature
56+
```
57+
58+
1. Submit a pull request through the GitHub website.
59+
60+
Thank you for helping us improve!

0 commit comments

Comments
 (0)