Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

96 lines (68 loc) · 3.88 KB

Contributing to Cross-Compatible FileLock

First off, thank you for considering contributing to Cross-Compatible FileLock! Your help is highly appreciated and essential for the growth and improvement of this project.

The following is a set of guidelines for contributing to the project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

  1. How to Report a Bug
  2. How to Submit a Feature Request
  3. How to Contribute Code
  4. Code of Conduct

How to Report a Bug

If you find a bug in the project, please create an issue on GitHub. Before creating an issue, please check if the issue has already been reported.

Steps to Report a Bug

  1. Check Existing Issues: Ensure your issue hasn’t already been reported.
  2. Create a New Issue: If no existing issue covers your bug, create a new issue.
  3. Provide Detailed Information: Include as much detail as possible:
    • A descriptive title
    • Steps to reproduce the bug
    • Expected behavior
    • Actual behavior
    • Environment (OS, Compiler, etc.)
    • Any relevant logs or screenshots

How to Submit a Feature Request

Feature requests are welcome. If you have an idea to improve the project, please create an issue on GitHub to discuss it.

Steps to Submit a Feature Request

  1. Check Existing Issues: Ensure your feature request hasn’t already been suggested.
  2. Create a New Issue: If no existing issue covers your feature request, create a new issue.
  3. Provide Detailed Information: Include as much detail as possible:
    • A descriptive title
    • A detailed explanation of the feature
    • Why this feature would be useful
    • Any code snippets or examples that help illustrate the feature

How to Contribute Code

We welcome contributions in the form of bug fixes, new features, and improvements. Please follow these steps to contribute code:

Steps to Contribute Code

  1. Fork the Repository: Fork the repo on GitHub and clone your fork locally.

    git clone https://github.com/your-username/Cross-Compatible-FileLock.git
cd Cross-Compatible-FileLock

  2. Create a Branch: Create a new branch for your work.

    git checkout -b feature-or-bugfix-description

  3. Make Changes: Implement your changes in the new branch. Follow the style guides and ensure your code is well-documented.

  4. Commit Your Changes: Commit your changes with a descriptive commit message.

    git add .
git commit -m "Description of the changes"

  5. Push to Your Fork: Push your changes to your fork on GitHub.

    git push origin feature-or-bugfix-description

  6. Create a Pull Request: Create a pull request on the original repository. Provide a detailed description of your changes and any related issue numbers.

Pull Request Guidelines

  • Ensure your code compiles and work.
  • Follow the existing code style and structure.
  • Provide a clear and detailed description of the changes.
  • Reference any relevant issues in your pull request description.
  • Remember that you are addressing a community in your description and code.

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.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Thank You!

Thank you for your interest in contributing to Cross-Compatible FileLock. Your efforts and time are greatly appreciated and will help make this project better for everyone!