Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
221 lines (163 loc) · 9.83 KB

CONTRIBUTING.md

File metadata and controls

221 lines (163 loc) · 9.83 KB

Contributing to lic

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to kushvinth.m@gmail.com.

I Have a Question

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (Python, uv, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side (e.g. using incompatible environment components/versions). If you are looking for support, you might want to check this section.
  • Check if there is not already a bug report existing for your bug or error in the issue tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Version of Python, uv, and lic-cli
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to kushvinth.m@gmail.com.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue.
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for lic, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the README carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most lic users.

Your First Code Contribution

Setting Up Your Development Environment

  1. Fork and clone the repository:

    git clone https://github.com/YOUR-BEAUTIFUL-NAME/lic.git
cd lic

  2. Install uv (if you haven't already):

    # macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

  3. Create a virtual environment and install dependencies:

    uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install -e .

  4. Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix

Making Changes

  1. Make your changes to the code in src/lic_cli/.
  2. Test your changes thoroughly: 
    # Run the CLI locally
lic
  3. Ensure your code follows the project's style guidelines (see Styleguides).

Submitting Your Changes

  1. Commit your changes:

    git add .
git commit -m "feat: add new feature" # or "fix: resolve bug"

  2. Push to your fork:

    git push origin feature/your-feature-name

  3. Open a Pull Request:

    • Go to the original repository
    • Click "New Pull Request"
    • Select your fork and branch
    • Provide a clear description of your changes
    • Reference any related issues

Improving The Documentation

Documentation improvements are always welcome! This includes:

  • Fixing typos or clarifying existing documentation
  • Adding examples or use cases
  • Improving the README
  • Adding inline code comments for complex logic

To contribute documentation:

  1. Follow the same process as Your First Code Contribution
  2. Make changes to relevant .md files or code comments
  3. Submit a pull request with your improvements

Styleguides

Git Commit Messages

  • Use the present tense ("add feature" not "added feature")
  • Use the imperative mood ("move cursor to..." not "moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable prefix:
    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • style: for formatting changes
    • refactor: for code refactoring
    • test: for adding tests
    • chore: for maintenance tasks

Python Code Style

  • Follow PEP 8 style guidelines
  • Use meaningful variable and function names
  • Keep functions focused and concise
  • Add docstrings for functions and classes
  • Use type hints where appropriate
  • Keep lines under 100 characters when possible
  • Use double quotes for strings consistently

Example:

def fetch_licenses() -> dict:
    """Fetch available licenses from GitHub API.
    
    Returns:
        dict: Dictionary mapping license keys to license information.
    """
    response = httpx.get("https://api.github.com/licenses", timeout=10.0)
    response.raise_for_status()
    return {lic["key"]: lic for lic in response.json()}

Thank you for contributing to lic! 🎉