Skip to content

Latest commit

 

History

History
130 lines (74 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

130 lines (74 loc) · 3.14 KB

Contributing to Fair Job Offer (FJO)

+1tada First off, thanks for taking the time to contribute! tada+1

The following is a set of guidelines for contributing to FJO and its content, which are hosted in the Mikzuit Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

What should I know before I get started?

FJO Sripts FJO Languages How Can I Contribute?

Reporting Bugs

Suggesting Enhancements Your First Code Contribution Pull Requests

Styleguides

Git Commit Messages Documentation Styleguide

Additional Notes

Issue and Pull Request Labels

Code of Conduct

What should I know before I get started

FJO Scripts

// to do

FJO Languages and legal

// to do

How can I contribute?

// to do

Reporting Bugs

Suggesting Enhancements

// to do

Your First Code Contribution

// to do

Pull Request

// to do

Styleguides

Git Commit Messages

Use the present tense ("Add feature" not "Added feature") Use the imperative mood ("Move cursor to..." not "Moves cursor to...") Limit the first line to 72 characters or less Reference issues and pull requests liberally after the first line When only changing documentation, include [ci skip] in the commit title

Consider starting the commit message with an applicable emoji:

Follow https://gitmoji.dev/ guide

Tada 🎉 Begin a project

Bookmark 🔖 Release / Version tags

Pencil ✏️ Fix typos

Rotating light 🚨 Fix compiler / linter warnings

Hammer 🔨 refactor code

Art 🎨 when improving the format/structure of the code

Racehorse 🐎 when improving performance

Non-potable_water 🚱 when plugging memory leaks

Memo 📝 Add or update documentation

Poop 💩 Write bad code that needs to be improved

Lipstick 💄 Add or update the UI and style files.

Children crossing 🚸 Improve user experience / usability.

iPhone 📱 Work on responsive design.

Bug 🐛 when fixing a bug

Fire 🔥 when removing code or files

Green_heart 💚 when fixing the CI build

Construction worker 👷 Add or update CI build system.

Construction 🚧 Work in progress

Ambulance 🚑 Critical hotfix

Rotating light 🚨 Fix compiler / linter warnings

White_check_mark ✅ add, update, or pass tests

Lock 🔒 Fix security issues

Recycle ♻️ Refactor code

Heavy plus sign ➕ Add a dependency

Heavy minus sign ➖ Remove a dependency

Arrow up ⬆️ when upgrading dependencies

Arrow down ⬇️ when downgrading dependencies

Adhesive bandage 🩹 Simple fix for a non-critical issue.

Zap ⚡ improve performance

Additional Notes

Issue and Pull Request Labels

You are free to PR this project and contribute with any issue. Check the license.