Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

84 lines (55 loc) · 3.22 KB

Contributing to git-semver

Thank you for your interest in contributing to the git-semver project! Whether you're submitting a bug report, fixing a bug, or adding a feature, we appreciate your help in making this action better.

How to Contribute

Reporting Issues

If you've encountered a bug or have a suggestion for improvement, please check the Issues tab to see if it's already been reported. If not, feel free to open a new issue with as much detail as possible, including:

  • A clear description of the problem or feature request.
  • Steps to reproduce the issue (if applicable).
  • The expected behavior and any error messages.
  • Your environment details (e.g., operating system, GitHub Actions version).

Submitting a Pull Request

We welcome contributions through pull requests! To submit a pull request:

  1. Fork the repository:
    Click the "Fork" button at the top of the repository page to create a copy of the project under your GitHub account.

  2. Clone your fork:
    Clone your forked repository to your local machine:

    git clone https://github.com/YOUR_USERNAME/git-semver.git

  3. Create a branch:
    Create a new branch for your changes:

    git checkout -b feature-branch

  4. Make your changes:
    Make your changes to the codebase. Ensure that you test your changes thoroughly and maintain existing functionality.

  5. Commit your changes:
    Commit your changes with a clear and concise commit message. Follow the Conventional Commit guidelines if possible.

    git commit -m "feat: added new feature to install specific version"

  6. Push your changes:
    Push your changes to your forked repository:

    git push origin feature-branch

  7. Create a Pull Request:
    Open a pull request (PR) from your feature branch to the main branch of the original repository.

  8. Describe your changes:
    Provide a detailed description of the changes you made in the PR and link any relevant issues.

Code Style

  • Use Prettier to format your code.
  • Ensure that your code follows the conventions and structure of the existing codebase.

Testing

Ensure that your changes do not break existing functionality. If possible, include tests for any new features or bug fixes.

Documentation

If you make changes that affect how the action works or how it is used, please update the documentation (including the README.md and this CONTRIBUTING.md) to reflect the changes.

License

By contributing to this project, you agree that your contributions will be licensed under the Apache License 2.0.

Code of Conduct

By participating in this project, you agree to adhere to the project's Code of Conduct. We strive to maintain a welcoming and respectful community for everyone.

Thank You!

Your contributions are what make this project great. Thank you for helping improve git-semver!

Author: Roger Barker
Email: [email protected]