Skip to content

Latest commit

 

History

History
113 lines (61 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

113 lines (61 loc) · 4.52 KB

Contributing to GitHub Covid Finder

🎉🚀🙌🏻 First off, thanks for taking the time to contribute! 🙌🏻🚀🎉

First off, thank you for considering contributing to this repository. It's people like you that make Open Source so great.

Please read our guidelines before you start.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Contributions we are looking for.

We keep an open mind! Improving documentation, bug triaging, or writing tutorials are all examples of helpful contributions that mean less work for you.

Ground Rules

Follow our Code of Conduct.

We expect everyone to abide by our Code of Conduct. Please read it. 🤝

Your First Contribution

Here are a couple of friendly tutorials to help you get started: http://makeapullrequest.com/ and http://www.firsttimersonly.com/

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

Getting started

Prerequisites

You will need at least node and yarn installed.

In this repo we favour yarn over npm as the "official" package manager.

Run the project

1 - Install dependencies

yarn

2 - Run the project in development mode.

yarn start

How to find components

We use Ant Design specification as the component framework.

You should look for components here first.

React version and Functional Components

We are on the latest version of React.

  • We favour functional components and hooks to class components.
  • We also prefer multiple small components to a big one

Create React App logoCheck here for latest version of React

Styling CSS with Modules

Styling is accomplished by using css modules.

Leave classic css to global styles.

How to report a bug

If you find a security vulnerability, do NOT open an issue. Email [email protected] instead.

Open an issue using the BUG template provided.

How to suggest a feature or enhancement

Open an issue using the FEATURE template provided.

Code review process

For your contribution to get accepted after it’s been submitted.

Your contribution will have to be Approved by a member of the Core Team before being merged.

The core team looks at Pull Requests on a regular basis. After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

Code, commit message and labeling conventions

Commit message conventions.

We follow the conventional commits guidelines. Check here

Code Style Enforced by Prettier

Prettier guarantees the code style adopted and runs on commit, stick to this code style.

Prettier Prettier site for more information

PULL Requests

Opening pull requests should be done using the github template, with enough information and screenshots for visual changes to facilitate the reviewers job. Its MANDATORY to add a link to the issue related