Skip to content

Commit

Permalink
Cleaned the codebase (covid19india#312)
Browse files Browse the repository at this point in the history
* Added support for ESLint, Prettier, and SCSS Linter with pre-commit hooks
  • Loading branch information
jeremyphilemon authored Mar 29, 2020
1 parent 37ab519 commit 21d3c6e
Show file tree
Hide file tree
Showing 79 changed files with 135,867 additions and 6,485 deletions.
24 changes: 16 additions & 8 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,29 @@ module.exports = {
browser: true,
es6: true,
},
extends: ["plugin:react/recommended", "google", "prettier", "prettier/react"],
extends: ['plugin:react/recommended', 'google', 'prettier', 'prettier/react'],
globals: {
Atomics: "readonly",
SharedArrayBuffer: "readonly",
Atomics: 'readonly',
SharedArrayBuffer: 'readonly',
},
parser: 'babel-eslint',
parserOptions: {
ecmaFeatures: {
jsx: true,
},
ecmaVersion: 2018,
sourceType: "module",
sourceType: 'module',
},
plugins: ["react", "prettier"],
plugins: ['react', 'prettier'],
rules: {
"require-jsdoc": 0,
"prettier/prettier": "error",
'require-jsdoc': 0,
'prettier/prettier': 'error',
'no-invalid-this': 0,
'react/prop-types': 0,
},
}
settings: {
react: {
version: 'detect',
},
},
};
18 changes: 10 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ about: Create a report to help us improve
title: ''
labels: 'Status: Review Needed, Type: Bug'
assignees: jeremyphilemon, JunaidBabu, sudevschiz

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
Expand All @@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Suggest an idea for this project
title: ''
labels: 'Status: Review Needed, Type: Enhancement'
assignees: JunaidBabu, sudevschiz

---

**Is your feature request related to a problem? Please describe.**
Expand Down
9 changes: 5 additions & 4 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"endOfLine": "auto",
"semi": false,
"singleQuote": false,
"endOfLine": "lf",
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5"
"trailingComma": "es5",
"bracketSpacing": false
}
43 changes: 20 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
# Contributing to covid19india.org website

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

These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.


Regarding PRs to this project, always submit a PR against an "issue". If an issue doesn't exist, please raise one first.


Two kinds of issues can be raised in this project:

1. Bug report
2. Feature Request


## Process Flow

* When a new issue is created, "Status: Review Needed" and "Type:Bug or Type:Enhancement" label is automatically added to it.
* Mods periodically check "Status:Review Needed" and add appropriate Priority and Status labels. If the issue is clear, set the status label as "Status: Available"
* People looking to contribute, filter issues by ["Status:Available"](https://github.com/covid19india/covid19india-react/issues?q=is%3Aissue+is%3Aopen+label%3A%22Status%3A+Available%22) and comment on the issue that, they are working on it.
* Mods change the status label to "Status:Accepted" and assign the issue to the contributor.
* Contributor change the label to "Status: In Progress" and finally submit the pull request.
# Contributing to covid19india.org website

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

These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Regarding Pull Requests to this project, always submit a PR against an "Accepted Issue" assigned to you. If an issue doesn't exist, please raise one first and wait for it to get accepted, and assigned. PRs without having accepted issues mentioned will be closed. The only exception to this rule are for PRs that address critical bug fixes that cannot wait for a maintainer's approval.

Two kinds of issues can be raised in this project:

1. Bug report
2. Feature Request

## Process Flow

- When a new issue is created, "Status: Review Needed" and "Type:Bug or Type:Enhancement" label is automatically added to it.
- Mods periodically check "Status:Review Needed" and add appropriate Priority and Status labels. If the issue is clear, set the status label as "Label: Available"
- People looking to contribute, filter issues by ["Status:Available"](https://github.com/covid19india/covid19india-react/issues?q=is%3Aissue+is%3Aopen+label%3A%22Status%3A+Available%22) and comment on the issue that they would like to be assigned to work on it.
- Mods change the status label to "Status:Accepted" and assign the issue to the contributor.
- Contributor change the label to "Status: In Progress" and finally submit the pull request.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,19 @@
</p>

<p align="center">
View our <a href="https://docs.google.com/spreadsheets/d/1nzXUdaIWC84QipdVGUKTiCSc5xntBbpMpzLm6Si33zk">live patient database</a>. If you'd like to collaborate, join the <a href="https://t.me/covid19indiaops">Telegram Group</a>.
View our <a href="https://bit.ly/patientdb">live patient database</a>.
</p>


## Setup
On Windows
```
npm i && npm run start-win
```
On Linux

```
npm i && npm start
```

## Maintainers

- [jeremyphilemon](https://github.com/jeremyphilemon)

## Contributors
- [s-naveen](https://github.com/jeremyphilemon/covid19-india/pulls?q=is%3Apr+author%3As-naveen+is%3Aclosed)
## Contribution

If you're new to contributing to Open Source on Github, [this guide](https://guides.github.com/activities/contributing-to-open-source/) can help you get started. Please check out the contribution guide for more details on how issues and pull requests work.
Loading

0 comments on commit 21d3c6e

Please sign in to comment.