Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

56 lines (34 loc) · 1.52 KB

Contributing to the Ma'akaf Website

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued.

Table of Contents

I Want To Contribute! ⭐

Please take a look at the Issues Page, and see how you can support our efforts!

We have various tasks, for all experience levels, please be sure to communicate which task you want to undertake, and ensure that on one is already working on that specific issue.

I Have Encountered a Bug! 🐛

If you have encountered a bug, please submit a new Bug Issue.

When describing the bug, please be as concise as possible, try your best to describe

exactly what you were doing when you encountered the bug, reproducing a bug is half the solution!

Before Submitting PRs 🚨

All PR's need to pass our Checks in order to be considered.

These include our linting process, our code formatting, and ensuring a successful build.

In order to run a lint locally:

npm run lint

In order to format your code:

npm run format

In order to build your branch:

npm run build

Please be sure to run these steps before opening your PR,

to avoid unnecessary spams in our checks page, and unneeded work for the Github Runners 🏃