Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (44 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

47 lines (44 loc) · 2.91 KB
Raw

I want to contribute!

first off: you're a hero.
If you want to contribute to this module, but are not sure where to start, look for issues with a low weight.

How to report a bug

If you have found a bug please submit an issue to the issuetracker and attach the label Type:Bug to the new issue.
If it happens that you know the solution to an existing bug, please first open the issue in order to keep track of it and then open the relevant merge request that potentially fixes it.

How to request an "enhancement"

To create a feature request for the API module please submit an issue to the issuetracker and assign the label Type:Enhancement to the issue. If you feel like you can contribute to the enhancement please do so and open a relevant Merge Request when required.

How to submit changes

I welcome Merge Requests with fixes and improvements to the module. For feedback during development of the enhancement or fix please open an issue in Gitlab. When ready please submit a Merge Request

Merge request guidelines

  1. Fork the project into your personal space on GitLab.com
  2. Create a feature branch, branch away from master
  3. add your fix or change to the changelog
  4. If you have multiple commits please combine them into one commit by squashing them
  5. Push the commit(s) to your fork
  6. Submit a merge request (MR) to the master branch
  7. The MR title should describe the change you want to make
  8. The MR description should give a motive for your change and the method you used to achieve it.
  9. Fill in the template already provided in the "Description" field.
  10. Link any relevant [issues][ce-tracker] in the merge request description and leave a comment on them with a link back to the MR
  11. Be prepared to answer questions and incorporate feedback even if requests for this arrive weeks or months after your MR submission
  12. When writing commit messages please follow these guidelines.

Who is already involved?

if you ever feel like you need help within an issue or enhancement please mention me in the issue or contact me on twitter

Contributors