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

Latest commit

 

History

History
37 lines (24 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.68 KB

How to contribute

Unfortunately we all can't work on MeowTube every day of the year, so I have decided to write some guidelines for contributing.

If you follow them your contribution will likely be pulled in quicker.

Getting Started

  • Fork the repository on GitHub (It's that easy)
  • Create a feature branch based on the main branch.

Making Changes

  • Make changes in your separate branch.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are easy to understand
  • Squash your 'Correcting mistakes' commits if you have a lot of them. (See the 'Squashing Commits' link below)
  • Make sure your changes won't affect new users or user without a customised system or different OS, try out your changes on a fresh VM to see if it would affect a new user's experience.

Making Trivial Changes

Documentation

  • If the documentation is about a currently available feature in MeowTube or correcting already created documentation, you can safely make your changes on the master branch and pull request them onto master.

Submitting Changes

  • Push your changes to the branch in your fork of the repository.
  • Submit a pull request to the develop branch of the MeowTube repository (unless it's a change in documentation [see above]).
  • Make sure you explicitly say to not complete the pull request if you are still making changes.

Additional Resources