Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

58 lines (45 loc) · 2.72 KB

How do I contribute?

What needs to be done?

Simply check the issue board! You may start a branch on an issue that isn't formally declared but this is usually a bad idea in the case where someone else may be working on the same thing and there ends up being a conflict.

If you would like to add an issue, first make sure that no similar issue already exists. If one exists then simply add any useful findings. When creating a new issue you will be given a template - please make use of these as they enforce descriptive and well thought out solutions/fixes.

Making changes

Start by fork + cloning the project. Once you make an addition then make the pull request, easy!

If you are a contributor then you may go the branching route. Prefix your branch as follows:

  • feat/ When the change is primarily an enhancement
  • fix/ When the change is primarily a bug fix
  • docs/ When the change is primarily adding documentation or code commenting

Making a Pull Request

Title: No emojis in the title. This is a simple and concise header

Body: The body should be a concise, bulleted list describing changes made

All pull requests are Squashed and Merged where the commit message is the title and the description is a list of bullet points describing the changes.

Commit Messages

Commit messages are prefixed with emojis for easy categorization. Commits should be loosely categorized but this won't be enforced particularly strictly. Here is a list of prefixes:

  • 🎨 :art: Improving structure / format of the code.
  • ⚡ :zap: Improving performance.
  • 🔥 :fire: Removing code or files.
  • 🐛 :bug: Fixing a bug.
  • 🚑 :ambulance: Critical hotfix.
  • ✨ :sparkles: Introducing new features.
  • 📝 :pencil: Writing/updating docs.
  • 💄 :lipstick: Updating the UI and style files.
  • 🎉 :tada: Initial commit.
  • ✅ :white_check_mark: Updating tests.
  • 🔒 :lock: Fixing security issues.
  • 🚧 :construction: Work in progress.
  • 💚 :green_heart: Fixing CI Build.
  • ⬇️ :arrow_down: Downgrading dependencies.
  • ⬆️ :arrow_up: Upgrading dependencies.
  • ♻️ :recycle: Refactoring code.
  • ➕ :heavy_plus_sign: Adding a dependency.
  • ➖ :heavy_minus_sign: Removing a dependency.
  • 🔧 :wrench: Changing configuration files.
  • ✏️ :pencil2: Fixing typos.
  • 🚚 :truck: Moving or renaming files.
  • 🍱 :bento: Adding or updating assets.
  • 🏗️ :building_construction: Making architectural changes.
  • 🙈 :see_no_evil: Adding or updating .gitignore file.

Anything beyond 50 characters needs to be placed in the description in bullet form.