Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 1.88 KB

Contributing to go1pylib

First off, thanks for taking the time to contribute! The following guidelines help us make contributions easy and effective.

Table of Contents

  1. Getting Started
  2. Reporting Bugs
  3. Suggesting Enhancements
  4. Submitting a Pull Request
  5. Coding Standards
  6. License

Getting Started

  1. Fork the repository on GitHub.

  2. Clone your fork locally:

    git clone https://github.com/chinmaynehate/go1pylib.git

  3. Create a branch for your work:

    git checkout -b feature/your-feature-name

  4. Make sure to install all necessary dependencies and test your changes before submitting.

Reporting Bugs

If you find a bug, please report it by creating an issue in the Issues section. Provide as much detail as possible, including steps to reproduce the bug.

Suggesting Enhancements

We welcome suggestions! Please open an issue with the enhancement label and describe your idea.

Submitting a Pull Request

  1. Make sure your code is up-to-date with the main repository.

    git fetch upstream
git merge upstream/main

  2. Commit your changes with a clear and concise commit message:

    git commit -m "Add feature: your feature description"

  3. Push to your branch:

    git push origin feature/your-feature-name

  4. Open a Pull Request with a description of your changes.

Coding Standards

  • Write clear, concise code and comments.
  • Follow PEP 8 for Python code style.
  • Run tests to verify your changes.

License

By contributing, you agree that your contributions will be licensed under the same license as the project.

Thank you for contributing!