Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (31 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 2.55 KB

Contributing to Semver-Manager

First and foremost, thank you for considering contributing to Semver-Manager! We appreciate your time and efforts in helping improve this project. This document outlines the guidelines for contributing to Semver-Manager and will help ensure a smooth and efficient collaboration process.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please take a moment to read through it before contributing.

Getting Started

To get started, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Commit your changes and push them to your fork.
  4. Open a pull request.

Reporting Bugs and Requesting Features

To report a bug or request a feature, please open an issue on the GitHub repository. When reporting a bug, please provide as much information as possible, including:

  • A clear and concise description of the bug or feature.
  • Steps to reproduce the issue (if applicable).
  • The expected behavior and actual behavior.
  • Screenshots or logs (if helpful).

Pull Requests

To ensure efficient and effective collaboration, please follow these guidelines when submitting a pull request:

  1. Make sure your changes are based on the latest main branch.
  2. Create a new branch with a descriptive name, such as fix-bug-123 or add-feature-xyz.
  3. Keep your changes focused and avoid including unrelated commits.
  4. Write clear and concise conventional commit messages that explain the changes you've made.
  5. If your changes address an open issue, reference the issue number in your commit messages (e.g., Fixes #123).
  6. Before submitting your pull request, ensure your code passes all tests and follows the project's coding style and conventions.
  7. Write or update tests for your changes if necessary.
  8. Update the documentation if your changes require it.

Code Review Process

Once you've submitted a pull request, maintainers and contributors may review your code and provide feedback. Be prepared to answer questions, clarify your changes, or make additional modifications if necessary. Remember that everyone is working together to improve the project, and feedback is intended to be constructive and helpful.

Community

If you have questions, need help, or want to discuss ideas, feel free to open an issue. We're always happy to welcome new contributors and help them get started.

Once again, thank you for considering contributing to Semver-Manager. We're excited to have you join our community and work together to make this project even better!