Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

72 lines (47 loc) · 3.29 KB
Raw

Contributing to Git-SSH-Sign

Thank you for considering contributing to git-ssh-sign! We welcome contributions from the community and appreciate your help in making this project better. Before you start contributing, please take a moment to read the following guidelines.

Table of Contents

Code of Conduct

We have adopted a Code of Conduct that we expect project participants to adhere to. Please read CODE_OF_CONDUCT.md for details.

Getting Started

Before you begin contributing, you should:

  • Fork the repository
  • Clone the forked repository to your local machine
  • Create a new branch for your work
  • Review the project's documentation to understand its architecture and guidelines
  • Optional (but encouraged): Star the project

How to Contribute

Here are some ways you can contribute to this project:

  • Reporting bugs
  • Suggesting new features
  • Writing code
  • Improving documentation
  • Providing feedback / Ask questions

Please ensure that your contributions align with the project's goals and follow the guidelines below.

Pull Request Guidelines

Before creating a pull request (PR), please ensure you create an issue first, if one does not already exist. This achieves two things:

  1. It ensures technical decisions that need to be made can be discussed before you start writing code, leading to less refactoring and change requests before merging your code.
  2. It ensures the bug or feature you are contributing to is documented showing other contributors that this bug/feature is being worked on, avoiding the unfortunate problem of having more than one PR for the same bug/feature.

To get started on your PR:

  • Fork the repository and create a new branch.
  • Make sure your code follows the project's coding style and conventions.
  • Write clear and concise commit messages.
  • Test your changes thoroughly.
  • Update the documentation if necessary.
  • Submit a pull request, explaining the purpose of the changes and any relevant information.

Reporting Bugs

If you find a bug or issue in the project, please report it using the Issue Tracker. Please fill in all the required information in the provided template to the best of your abiliy, including a detailed description of the problem and steps to reproduce it.

Feature Requests

If you have an idea for a new feature or improvement, please open an issue in the Issue Tracker and use the "feature request" template provided. Describe the proposed feature and its benefits.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE file of this repository.

Thank you for your interest in git-ssh-sign! We look forward to your contributions.