Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

72 lines (44 loc) · 2.6 KB
Raw

Contributing to the marimo tutorials repository

Before you get started, please take a moment to read through this document to understand how you can contribute and the guidelines you should follow.

How to Contribute

  1. Fork the repository to your own GitHub account.

  2. Clone the forked repository to your local machine:

    git clone [your_fork_url]

  3. Create a new branch for your work:

    git checkout -b feature/your-feature-name

  4. Make your changes, improvements, or fixes. When developing new features or experimenting with the codebase, you might want to create files that should not be tracked by Git to avoid cluttering the main repository. A common practice is to prefix these file names with a + sign. For example, naming a file +experiment.py will make it clear that this file is for personal or temporary use and should not be included in version control.

  5. Commit your changes with clear and concise commit messages:

    git commit -m "Your commit message"

    you can refer to this link for more information on conventional commits

  6. Push your changes to your fork on GitHub:

    git push origin feature/your-feature-name

  7. Create a pull request (PR) to the main repository. Be sure to include a clear description of your changes.

  8. Your PR will be reviewed, and any necessary adjustments or discussions will take place.

  9. Once your PR is approved, it will be merged into the main branch.

Code Style and Guidelines

Please follow these guidelines to ensure consistency and maintainability:

  • Use clear and descriptive variable and function names.
  • Follow the existing code style, including indentation and formatting.
  • Write comments for complex or non-obvious sections of code.
  • Write clear and concise commit messages.

Reporting Bugs

If you find a bug in the app, please help us by reporting it. To report a bug, use the GitHub Issues tab and provide the following information:

  • A clear and descriptive title.
  • Detailed steps to reproduce the bug.
  • Expected behavior and actual behavior.
  • Any error messages or logs, if applicable.

Feature Requests

We welcome feature requests. If you have an idea for a new feature or improvement, please create an issue in the GitHub Issues tab. Be sure to describe the feature or improvement clearly and provide any relevant context.

Code of Conduct

Please review and adhere to our Code of Conduct to ensure a welcoming and inclusive community.

Thank you for contributing to the marimo-tutorials repository!

Happy coding!