Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

81 lines (55 loc) · 1.76 KB

Contributing to ByePass

Thank you for your interest in contributing to ByePass! We welcome all contributions, whether it's reporting a bug, suggesting an enhancement, improving documentation, or submitting a pull request.

How to Contribute

1. Fork the Repository

  • Click the Fork button at the top-right corner of this repository.

2. Clone Your Fork

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

3. Create a Branch

Make your changes in a feature or bugfix branch:

git checkout -b feature/your-feature-name

4. Make Your Changes

  • Follow the project coding guidelines.
  • Ensure your code is well-documented and tested.

5. Commit Your Changes

git add .
git commit -m "Add feature: descriptive commit message"

6. Push Your Changes

git push origin feature/your-feature-name

7. Submit a Pull Request

  • Go to the original repository on GitHub.
  • Click New Pull Request.
  • Provide a clear title and description of your changes.

Code Style & Standards

  • Follow the existing code style and naming conventions.
  • Write clear and concise commit messages.
  • Include tests for your changes whenever possible.

Linting & Formatting

Ensure your code passes lint checks

Reporting Bugs

  • Open an issue using the Bug Report template.
  • Provide clear steps to reproduce the issue.
  • Include logs, screenshots, or error messages if possible.

Suggesting Features

  • Open an issue using the Feature Request template.
  • Describe the feature and why it would be useful.

Documentation Contributions

  • Improvements to documentation are always welcome!
  • Update relevant .md files in the repository.

Thank You!