Skip to content

Latest commit

 

History

History
83 lines (51 loc) · 3.91 KB

CONTRIBUTING.md

File metadata and controls

83 lines (51 loc) · 3.91 KB
Raw

Contributing to this repository

First off all, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. There are different ways you can help on this project to make the Simple LAPS GUI a great and loved tool.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which I would also be very happy about:

  • Star the project
  • Write about it in your blog or on social media
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

On all your contributions and communication

  • be politely and respectful to other peoples.
  • don't contribute any crime content, hateful content or anything else that is against the law.

I Have a Question

Before you ask a question, it is best to read the available FAQ and to search for existing issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, I recommend the following:

  • Open an issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions, depending on what seems relevant.

I will then take care of the issue as soon as possible.

I Want To Contribute

⚠️ Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before you report a bug please make sure that you use the latest version and that it isn't reported already.

A good bug report contains at least the following information:

  • A detailed description of the problem.
  • The version of your OS and the version of the Simple LAPS GUI tool.
  • A description of the steps needed to reproduce the problem.
  • And optional a screenshot.

Suggesting Enhancements

Before you suggest a new feature or enhancement please make sure that you use the latest version and that there doesn't exist a request for this feature/enhancement already.

A good suggestion describes what you like to see in the app and when this is helpful. If you have any information (documentations, links and so on) that can help when implementing your idea, feel free to add them to your request.

Contributing PRs

⚠️ If you want to contribute any PRs containing code changes, documentation changes or anything else please make sure that your contribution is in compliance with the legal requirements!!

Before starting the work on something please inform the repository owner in the corresponding issue and discuss implementation there.

A good PR

  • Has a corresponding issue. (If it doesn't exist please create it.)
  • It fixes or implements only one thing.
  • It has a good title and description that makes clear what it changes.
  • It has a filled checklist.

A good commit message

It is short but exact in what has changed (e.g. "Readme: Update limitations list").

Merging of PRs

Only the repository owner can merge your PR and it will be reviewed before the merge.

It may happen that you PR doesn't get accepted. This has nothing to do with you as person and can have many reasons. In this case you will be informed.