Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 2.62 KB
Raw

Contributing to metriccoders_notebooks

Thank you for your interest in contributing to metriccoders_notebooks! We welcome contributions from the community to help improve and grow this project. By participating, you not only contribute to the development of this repository but also become a part of the vibrant open-source community.

How to Contribute

To contribute to metriccoders_notebooks, please follow these general steps:

  1. Fork the Repository:

    • Click on the "Fork" button at the top right corner of the repository's page. This creates a copy of the repository in your GitHub account.

  2. Clone the Repository:

    • Clone the forked repository to your local machine using the following command: 
      git clone https://github.com/metriccoders/metriccoders_notebooks.git

  3. Create a Branch:

    • Create a new branch for your contribution: 
      git checkout -b feature/your-feature-name

  4. Make Changes:

    • Make your changes or additions to the codebase.

  5. Commit Changes:

    • Commit your changes with a descriptive commit message: 
      git commit -m "Add a concise commit message"

  6. Push Changes:

    • Push your changes to your forked repository: 
      git push origin feature/your-feature-name

  7. Create a Pull Request:

    • Open a pull request (PR) from your branch to the main branch of the original repository.

  8. Describe Your Changes:

    • Provide a clear and concise description of your changes in the PR description. Include any relevant information that can help reviewers understand the purpose and impact of your contribution.

  9. Review and Collaborate:

    • Be responsive to any feedback or comments from maintainers and collaborators. You may need to make additional changes based on the feedback received.

  10. Wait for Approval:

    • Once your contribution has been reviewed and approved, it will be merged into the main branch.

Code Style and Guidelines

Make sure to adhere to the coding style and guidelines established in the project. Familiarize yourself with any specific conventions mentioned in the project's documentation.

Issues and Discussions

If you want to report a bug, propose a new feature, or discuss the project, please use the Issues section. Be clear and detailed in your communication to facilitate effective discussion and resolution.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE of the project.

Thank you for contributing to metriccoders_notebooks! Your efforts are greatly appreciated.