Skip to content

Latest commit

 

History

History
112 lines (72 loc) · 5.29 KB

CONTRIBUTING.md

File metadata and controls

112 lines (72 loc) · 5.29 KB
Raw

Contributing to [mathpylearn] 🚀

Thank you for considering contributing to [mathpylearn]! We appreciate your interest in helping make this project better.

Table of Contents

How Can I Contribute? 🌟

Reporting Bugs 🐛

If you come across a bug or an issue with [WorkVed], please take the following steps:

  1. Search the [issue tracker](https://github.com/codingkatty/mathpylearn to check if the issue has already been reported. If it has, feel free to add any additional information or subscribe to the existing issue.

  2. Create a New Issue if the issue hasn't been reported yet, with a descriptive title and a clear description of the problem. Include any relevant details such as operating system, browser version, and steps to reproduce the issue.

Requesting Features ✨

If you have an idea for a new feature or improvement, please follow these steps:

  1. Search the issue tracker to check if the feature request already exists. If it does, you can comment on the existing request to provide more information or express your interest.

  2. Create a New Issue if the feature request doesn't exist, with a clear and concise title and a detailed description of the feature or enhancement you're proposing. Explain why it's valuable and how it aligns with the project's goals.

Submitting Changes 🛠️

If you want to contribute code changes, follow these steps:

  1. Fork the repository to your own GitHub account.

  2. Clone your forked repository to your local machine.

    git clone https://github.com/codingkatty/mathpylearn

  3. Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make your changes, following the style guide and ensuring that your code adheres to the project's coding standards.

  5. Commit your changes with a descriptive commit message.

    git commit -m "Add new feature: your feature name"

  6. Push your changes to your forked repository on GitHub.

    git push origin feature/your-feature-name

  7. Open a pull request (PR) on the [original repository] and provide a detailed description of your changes.

Alternatively contribute using GitHub Desktop 🖥️

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.

Pull Request Guidelines 📋

To ensure a smooth review process, please follow these guidelines when submitting a pull request:

  • Your code should be well-documented and include clear comments where necessary.
  • Run any relevant tests to ensure that your changes don't introduce new issues.
  • Ensure your code follows the project's coding standards and style guide.
  • Keep your pull request focused on a single feature or bug fix.
  • Provide a clear and concise title and description for your pull request.

License 📜

By contributing to [mathpylearn], you agree that your contributions will be licensed under the project's LICENSE.