Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (65 loc) · 4.03 KB

CONTRIBUTING.md

File metadata and controls

96 lines (65 loc) · 4.03 KB

Contributing to Hello-IPs

Thank you for your interest in contributing to Hello-IPs! Contributions help improve this project for everyone. Below are some guidelines to help you get started.

How Can I Contribute?

There are several ways you can contribute to Hello-IPs:

  • Reporting Bugs: Open an issue with detailed steps to reproduce, expected behavior, and actual behavior.
  • Suggesting Enhancements: Open an issue describing your feature request and the problem it solves.
  • Code Contributions: Whether you're fixing a bug, adding a new feature, or refactoring existing code, please follow our commit message conventions.
  • Documentation Improvements: Contributions to the documentation (README, inline docs, guides) are always welcome.

Getting Started

  1. Fork the Repository:
    Click the "Fork" button to create your own copy.

  2. Clone Your Fork:

    git clone https://github.com/your-username/Hello-IPs.git
cd Hello-IPs

  3. Create a New Branch:
    Choose a descriptive branch name related to your changes:

    git checkout -b feat/short-description

  4. Make Your Changes:
    Follow the coding style of the project (PEP8 recommended for Python).

  5. Commit Your Changes:
    Use one of the following commit message prefixes as the very first word of your commit message:

    Prefix Description
    feat: Introducing a new feature.
    fix: Fixing a bug.
    docs: Documentation only changes.
    style: Changes that do not affect meaning (whitespace, formatting, missing semicolons, etc.).
    refactor: Code changes that neither fix a bug nor add a feature.
    perf: Code changes that improve performance.
    test: Adding missing tests or correcting existing tests.
    build: Changes affecting the build system or dependencies (gulp, broccoli, npm, etc.).
    ci: Changes to our CI configuration files and scripts (Travis, Circle, etc.).
    revert: Reverts a previous commit.
    chore: Other changes that do not modify src or test files (e.g. auxiliary tools, build scripts).

  6. Push and Submit a Pull Request:

    git push origin blahblahblah

    Then, open a pull request on GitHub from your branch to the main branch.

Pull Request Guidelines

  • Descriptive Title and Description: Provide a clear title and detailed description of your changes.
  • Follow the Commit Message Conventions: Ensure your commit messages start with one of the approved prefixes.
  • Keep Pull Requests Focused: Aim for a single issue or feature per pull request.
  • Include Tests: If applicable, include tests for your changes.

Reporting Bugs or Requesting Features

  • Bug Reports: File an issue, including OS, version, and steps to reproduce.
  • Feature Requests: Open an issue with a clear description of your proposal and its benefits.

Licensing

By contributing to Hello-IPs, you agree that your contributions will be licensed under the Apache License 2.0.

Code of Conduct

This project adheres to a Code of Conduct. All contributors are expected to follow it.

Contact

If you have any questions or suggestions regarding contributions, please open an issue or contact the maintainer directly.

Thank you for your contributions!