Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.77 KB

File metadata and controls

59 lines (41 loc) · 1.77 KB

Contributing to Code Line Counter

Thank you for considering contributing to Code Line Counter! This document provides guidelines and instructions for contributing.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct: be respectful, considerate, and collaborative.

How Can I Contribute?

Reporting Bugs

  • Check if the bug has already been reported in the Issues section
  • Use the bug report template when creating a new issue
  • Include detailed steps to reproduce the bug
  • Add information about your operating system and Python version

Suggesting Enhancements

  • Check if the enhancement has already been suggested in the Issues section
  • Use the feature request template when creating a new issue
  • Describe the enhancement in detail and why it would be valuable

Pull Requests

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Run tests if available
  5. Commit your changes (git commit -m 'Add some feature')
  6. Push to the branch (git push origin feature/your-feature)
  7. Open a Pull Request

Development Setup

  1. Clone the repository
git clone https://github.com/SNO7E/Code-Line-Counter.git
cd Code-Line-Counter
  1. Set up a virtual environment (optional but recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install development dependencies if applicable

Style Guide

  • Follow PEP 8 guidelines for Python code
  • Use descriptive variable and function names
  • Add docstrings to your functions and classes
  • Keep line length to a maximum of 79 characters

License

By contributing to Code Line Counter, you agree that your contributions will be licensed under the project's MIT License.