Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (37 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 2.21 KB

Contributing to the Project

First off, thank you for considering contributing to this project! Your help is greatly appreciated.

This document outlines the guidelines for contributing. Please read it carefully to ensure a smooth and effective contribution process.

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

If you find a bug, please ensure it hasn't already been reported by searching the GitHub Issues. If you can't find an open issue addressing the problem, open a new one. Be sure to include a clear title, a detailed description of the bug, and steps to reproduce it.

Suggesting Enhancements

If you have an idea for an enhancement, please search the GitHub Issues to see if it has been suggested before. If not, open a new issue with a clear title and a detailed description of the proposed enhancement and its potential benefits.

Your First Code Contribution

Unsure where to begin? Look for issues tagged good first issue or help wanted. These are great starting points for new contributors.

Development Process

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/your-repository.git
  3. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
    or for a bug fix: 
    git checkout -b fix/bug-name
  4. Make your changes and commit them with a clear and concise commit message.
  5. Push your changes to your fork: 
    git push origin feature/your-feature-name
  6. Open a Pull Request to the main branch of the original repository. Provide a clear title and a detailed description of your changes.

Coding Style

Please follow the coding style of the existing codebase. Consistency is key. If there are linters or formatters configured in the project, please use them.

Questions?

If you have any questions, feel free to ask on the GitHub Issues page.

Thank you for your contribution!