Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (31 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

54 lines (31 loc) · 3.39 KB
Raw

Repository Contributor Guidelines

Introduction

Welcome to the repository for Jupyter notebooks covering machine learning, deep learning, statistics, and related topics. We appreciate your interest in contributing to this project. Before you get started, please review these guidelines to ensure a smooth and collaborative experience.

Contribution Process

  1. Fork the Repository: To begin contributing, fork this repository to your GitHub account.

  2. Branch Naming: When working on a specific topic or notebook, create a new branch with a descriptive name related to the content you are working on. For example, if you are working on a notebook about regression, you could name your branch "regression-notebook."

  3. Notebook Organization: Each notebook should be organized as follows:

    • Start with a clear title and brief description of the notebook's content.
    • Use Markdown cells for explanations and headings.
    • Include code cells with comments and explanations.
    • Ensure that code is well-documented and follows best practices.
    • Use Markdown to include any necessary equations or mathematical explanations.

  4. Commit Changes: Make meaningful and atomic commits with clear messages. For example:

    • "Added a new section on logistic regression."
    • "Updated code comments for better clarity."

  5. Pull Requests: When you're ready to contribute, open a pull request from your forked repository to the main repository. Clearly describe the purpose of your changes in the pull request description.

  6. Code Review: Expect feedback and code review from maintainers and fellow contributors. Be responsive to comments and make necessary revisions.

  7. Testing: Ensure that your code works correctly and does not introduce errors. If applicable, include test cases within your notebook.

Code and Documentation Standards

  1. Coding Style: Follow the coding style guidelines for Python and Jupyter notebooks. Consistency in code style is important for readability. If you're unsure, refer to PEP 8 for Python.

  2. Documentation: Clearly explain the purpose and context of your notebook in Markdown cells. Include explanations of code, algorithms, and concepts. Make sure your documentation is clear and accessible to a wide audience.

  3. Use of Libraries: When using external libraries (e.g., scikit-learn, TensorFlow), specify the version used and ensure your code is compatible with the most recent versions.

Collaboration and Communication

  1. Collaboration: Feel free to collaborate with others on improving existing notebooks or creating new ones. Coordination through issues and discussions is encouraged.

  2. Respectful Communication: Be respectful and constructive in your communication with other contributors. Healthy discussions and debates are welcome.

  3. Issues: If you encounter issues or have ideas for new notebooks, create a new issue to discuss it with the community.

Licensing

By contributing to this repository, you agree to license your work under the same license as the repository itself. Please ensure you have the necessary rights to make contributions.

Acknowledgment

We greatly appreciate your contributions to this repository and will acknowledge your work in the contributors' section.

Thank you for your interest in advancing the knowledge and resources available in the field of machine learning and statistics. Happy contributing!