CONTRIBUTING.md

🌍 Contributing.

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

👶 Getting Started!

Ready to contribute? Here's how to set up rust-data-analysis for local development.

1. Fork the rust-data-analysis repo on GitHub.

2. Clone your fork locally:

   git clone git@github.com:your_name_here/rust-data-analysis.git

3. Navigate to the recently created directory:

   cd rust-data-analysis

4. Install the main dependencies:

   # Install a Rust toolchain (e.g. nightly):
   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly
   
   # Install Jupyter Notebook
   pip install notebook
   
   # Install evcxr_jupyter
   cargo install evcxr_jupyter
   evcxr_jupyter --install	

5. Start Jupyter Notebook:

   jupyter notebook

6. Create a branch for local development:

   git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

1. Commit your changes and push your branch to GitHub:

   git add .
   git commit -m "Your detailed description of your changes."
   git push origin name-of-your-bugfix-or-feature

2. Submit a pull request through the GitHub website.

Thank you for helping us improve!