Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (74 loc) · 4.22 KB

CONTRIBUTING.md

File metadata and controls

101 lines (74 loc) · 4.22 KB

Contributing to GitHub Stars Exporter

Thank you for considering contributing to GitHub Stars Exporter! This document outlines the process for contributing to this project.

Code of Conduct

By participating in this project, you agree to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

  • 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.
  • **Provide specific examples to demonstrate the steps or point out the part of GitHub Stars Exporter which the suggestion is related to.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most GitHub Stars Exporter users.
  • List some other applications where this enhancement exists if applicable.

Pull Requests

  • Fill in the required pull request template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow the Python styleguide
  • Include thoughtfully-worded, well-structured documentation
  • End all files with a newline
  • Avoid platform-dependent code

Development Process

Setup Development Environment

  1. Fork the repository
  2. Clone your fork locally 
    git clone https://github.com/your-username/github-stars-exporter.git
cd github-stars-exporter
  3. Install dependencies 
    pip install -r requirements.txt

Style Guidelines

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 emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies

Python Styleguide

All Python code should adhere to PEP 8.

  • Use 4 spaces for indentation
  • Use docstrings for all public modules, functions, classes, and methods
  • Keep line length to a maximum of 100 characters
  • Use meaningful variable names

Testing

  • Include test cases for all new functionality
  • Ensure all tests pass before submitting a pull request
  • Write both unit tests and integration tests where applicable

Community

Join our community channels to discuss the project or get help:

Thank you for contributing to GitHub Stars Exporter!