Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 2.67 KB
Raw

Contributing to Scaling Science

First of all, thank you for considering contributing to the Scaling Science project! We value your time and contributions. This guide outlines the process for contributing to this project, including reporting bugs, submitting code, and improving documentation.

As a reminder, this is a Jupyter Book based project in which chapters encapsulate concepts. Some chapters have interactive code, whilst others are pure markdown. Please keep this in mind as you suggest edits or improvements.

How to Contribute

1. Reporting Bugs

If you encounter any issues or bugs while using the Scaling Science project, please open an issue and provide as much detail as possible:

  • A clear and concise description of the problem.
  • Steps to reproduce the bug.
  • Any relevant screenshots, logs, or error messages.
  • Your environment details (OS, browser, etc.).

2. Suggesting Enhancements

We welcome suggestions for new features or improvements! If you have an idea that could make the project better, feel free to open an issue and label it as an enhancement. Please include:

  • A detailed description of the proposed change.
  • The motivation behind your suggestion.
  • Any alternatives you've considered.

3. Contributing Code

If you'd like to contribute code, follow these steps:

  1. Fork the repository by clicking the "Fork" button at the top right of the GitHub page.

  2. Create a branch for your feature or fix:

    git checkout -b my-feature-branch

  3. Commit your changes with clear and descriptive messages:

    git commit -m "Add new feature or fix description"

  4. Push the branch to your fork:

    git push origin my-feature-branch

  5. Open a pull request:

    • Go to the Pull Requests tab of the main repository.
    • Click "New pull request" and choose your branch from the drop-down menu.

4. Code Style and Guidelines

  • Ensure your code follows the PEP 8 style guide.
  • Include meaningful comments and documentation where appropriate.
  • Test your new feature and describe how you did so in the corresponding pull request.

Code of Conduct

Please note that all contributors are expected to adhere to our Code of Conduct. Be respectful, inclusive, and professional at all times.

Getting Help

If you need any help, feel free to open an issue or ask in the Discussions section of the repository.

Thank you for contributing to the Scaling Science project!