Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

42 lines (31 loc) · 2.17 KB
Raw

Contributing Guide

Thanks for taking the time to contribute! Any help is appreciated!

What Should You Know Before Starting

LoanShark's goal is to provide a clean, secure and easy to manage method for handling an admin's loaner fleet.

By easy to manage we mean:

  • Ensuring little additional configuration is needed.
  • Allowing entry level admins to be able to use LoanShark with no previous coding experience needed.

By secure we mean:

  • Ensuring only authorized users are able to manage the loaning period.
  • Sandboxed
  • Developer ID Signed application

How Can You Contribute

Contributing to documentation

The wiki is open to edit for everyone. Don't hesitate to modify it! Please ask for help in the Slack channel (see below) or create an issue.

Contributing to code

Please pick a topic in the issues section:

  • Beginner Issues - issues whcihs hould only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Please start from develop branch and name your branch using the feature, bugfix or enhancement tag before the name of the feature, bugfix, or enhancement.

  • Ex: feature/robust_logging

Make sure you:

  • Describe your work well
  • Reference the issue in your commit message
  • Update CHANGELOG.md
  • Use the correct username and email (make sure your employer is OK that you use your professional email)

Getting Help

The best place to discuss LoanShark is to join the #loanshark channel on the MacAdmins Slack.

Development Help

Since LoanShark is heavily written in Swift, the #swift channel on the MacAdmins Slack is a great resource for questions.

After your first Pull Request(PR) you will be invited to a private developer channel.