Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 2.83 KB

How to Contribute to AnyLock Locker System (LS)

Jump to

Issues

Features & Changes

Coding Conventions

Issues

If you happen to find find any bugs/issues go to the issues tab of this repo and submit a detailed description of the bug/issue.

A detailed description of a bug/issue:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Laravel, e.g. which command exactly you used in the terminal, or how you started Laravel otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut and if so which one?
  • Provide specific examples to demonstrate the steps. Includes links to files, GitHub projects, or copy/pasteable snippets, which you used in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Include screenshots/Animated GIFs/Screen recordings which demonstrate the steps you took.
  • Descibe the expected behaviour. What is supposed to happen?
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information about that.

Features or Changes

Submit a pull request via the Pull Requests of this repo.

Guidelines:

  • Provide screenshots/Screenrecordings that demonstrate the feature/change
  • Follow our coding conventions (below) / Read and match the conventions used in our code.
  • Keep the feature limited to one commit Keep it clean!
  • Write a clear commit message includes a detailed description of the changes and the impact on the code.

A detailed description of a feature/change:

  • Use a clear and descriptive title for the suggestion.

  • Provide a step-by-step description of the suggested feature/change in as many details as possible.

  • Explain why this feature/change is useful for AnyLock.

Coding Conventions:

  • 4 spaces for tabs
  • Classes and route names are camelCased e.g. class UserService
  • Variables and Functions use an underscore e.g. $rented_locker;
  • Keep the code flow the same Web routes go into routes/web.php, The controllers (app/Http/Controllers) route that to a function in a service file app/Http/Service where the method is actually implemented.

Thank you for considering to contribute to the AnyLock Locker System!