Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

56 lines (32 loc) · 2.94 KB

Contributing Guide

👏🏼💕😎 Thanks for taking the time to contribute!! 😎💕👏🏼

What should I know before starting?

SplashBuddy goal is to provide an elegant and secure onboarding process for Mac users using DEP.

By elegant we mean:

By secure we mean:

App Store Review Guidelines is a good additional resource.

♻️Note: The very fact that this app exists violates one of Apple guidelines for good app design: Think twice before providing an onboarding experience

How can I contribute?

Contributing to localizations

Please create an issue if a localization is incorrect, incomplete or missing.

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 if you're uncertain.

Contributing to code

Please create a pick a topic in the issues section:

  • Beginner issues - issues which should 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 master branch and create a PR when you're ready to submit the code.

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 SplashBuddy is to join the #splashbuddy channel on the MacAdmins Slack.

After your first merged PR, you'll be invited to the private developers channel 👻.