Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 2.71 KB
Raw

Contributing to VSM-GITLAB-BROKER

First off, thanks for taking the time to contribute! 🙌🎉

The following is a set of guidelines for contributing to this project.

How Can I Contribute?

Using Issues

We use GitHub issues to track public bugs and feature requests. If you have a general question, please reach out via other means.

Submitting an Issue

If your issue appears to be a bug and hasn't been reported or you would like to request a new feature or improvement, open a new issue.

Reporting Bugs

This section guides you through submitting a bug report for this project. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible. When listing steps, don't just say what you did, but explain how you did it.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, record the GIF with the Keybinding Resolver shown. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for this project, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.

Submitting a Pull Request

  • Open a new issue in the Issues tab and describe what you plan to change.
  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Make sure your code follows the existing style (e.g. End all files with a newline,.)
  • Include relevant unit tests.
  • Create a pull request.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues related to bugs.
  • enhancement - Issues related to enhancements.
  • documentation - Issues related to documentation.