Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added eslint and prettier #281

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
SKIP_PREFLIGHT_CHECK=true
7 changes: 7 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
**/node_modules
**/dist
**/package.json
**/package-lock.json
**/build
**/docs
**/.github
27 changes: 27 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"env": {
"browser": true,
"es2021": true,
"jest": true
},
"extends": ["eslint:recommended", "plugin:react/recommended", "plugin:prettier/recommended"],
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 12,
"sourceType": "module"
},
"plugins": ["react"],
"rules": {
"react/react-in-jsx-scope": "off",
"react/prop-types": 0,
"react/no-unescaped-entities": 0,
"no-constant-condition": 0
},
"settings": {
"react": {
"version": "detect"
}
}
}
38 changes: 18 additions & 20 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,28 @@ If you see someone who is making an extra effort to ensure our community is welc

The following behaviors are expected and requested of all community members:

* Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
* Exercise consideration and respect in your speech and actions.
* Attempt collaboration before conflict.
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
* Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
* Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
- Exercise consideration and respect in your speech and actions.
- Attempt collaboration before conflict.
- Refrain from demeaning, discriminatory, or harassing behavior and speech.
- Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
- Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.

## 4. Unacceptable Behavior

The following behaviors are considered harassment and are unacceptable within our community:

* Violence, threats of violence or violent language directed against another person.
* Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
* Posting or displaying sexually explicit or violent material.
* Posting or threatening to post other people’s personally identifying information ("doxing").
* Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
* Inappropriate photography or recording.
* Inappropriate physical contact. You should have someone’s consent before touching them.
* Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
* Deliberate intimidation, stalking or following (online or in person).
* Advocating for, or encouraging, any of the above behavior.
* Sustained disruption of community events, including talks and presentations.
- Violence, threats of violence or violent language directed against another person.
- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
- Posting or displaying sexually explicit or violent material.
- Posting or threatening to post other people’s personally identifying information ("doxing").
- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
- Inappropriate photography or recording.
- Inappropriate physical contact. You should have someone’s consent before touching them.
- Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
- Deliberate intimidation, stalking or following (online or in person).
- Advocating for, or encouraging, any of the above behavior.
- Sustained disruption of community events, including talks and presentations.

## 5. Consequences of Unacceptable Behavior

Expand All @@ -52,17 +52,15 @@ Anyone asked to stop unacceptable behavior is expected to comply immediately.
If a community member engages in unacceptable behavior, the community admins may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).

## 6. Reporting Guidelines
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community admin as soon as possible by emailing opensource@anitab.org. Please read [Reporting Guidelines](reporting_guidelines.md) for details.


If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community admin as soon as possible by emailing opensource@anitab.org. Please read [Reporting Guidelines](reporting_guidelines.md) for details.

Additionally, community admins are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, community admins (or event managers) will also provide escorts as desired by the person experiencing distress.

## 7. Addressing Grievances

Only permanent resolutions (such as bans) may be appealed. To appeal a decision of the working group, contact AnitaB.org staff at opensource@anitab.org with your appeal and we will review the case.


## 8. Scope

We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
Expand Down
34 changes: 17 additions & 17 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Contributing Guidelines

* You can join us on [AnitaB.org Open Source Zulip](https://anitab-org.zulipchat.com/). Each active repo has its own stream to direct questions to (for example #powerup or #portal). Bridge in Tech stream is [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech).
* Remember that this is an inclusive community, committed to creating a safe, positive environment. See the full [Code of Conduct](http://www.systers.io/code-of-conduct.html).
* Follow our [Commit Message Style Guide](https://github.com/anitab-org/bridge-in-tech-web/wiki/Commit-Message-Style-Guide) when you commit your changes.
* Please consider raising an issue before submitting a pull request (PR) to solve a problem that is not present in our [issue tracker](https://github.com/anitab-org/bridge-in-tech-web/issues). This allows maintainers to first validate the issue you are trying to solve and also reference the PR to a specific issue.
* When developing a new feature, include at least one test when applicable.
* When submitting a PR, please follow [this template](PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR).
* When submitting a PR with changes to user interface (e.g.: new screen, ...), please add screenshots to the PR description.
* When you are finished with your work, please squash your commits otherwise we will squash them on your PR (this can help us maintain a clear commit history).
* When creating an issue to report a bug in the project, please follow our [bug_report.md](https://github.com/anitab-org/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md) template.
* Issues labeled as “First Timers Only” are meant for contributors who have not contributed to the project yet. Please choose other issues to contribute to, if you have already contributed to these type of issues.
- You can join us on [AnitaB.org Open Source Zulip](https://anitab-org.zulipchat.com/). Each active repo has its own stream to direct questions to (for example #powerup or #portal). Bridge in Tech stream is [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech).
- Remember that this is an inclusive community, committed to creating a safe, positive environment. See the full [Code of Conduct](http://www.systers.io/code-of-conduct.html).
- Follow our [Commit Message Style Guide](https://github.com/anitab-org/bridge-in-tech-web/wiki/Commit-Message-Style-Guide) when you commit your changes.
- Please consider raising an issue before submitting a pull request (PR) to solve a problem that is not present in our [issue tracker](https://github.com/anitab-org/bridge-in-tech-web/issues). This allows maintainers to first validate the issue you are trying to solve and also reference the PR to a specific issue.
- When developing a new feature, include at least one test when applicable.
- When submitting a PR, please follow [this template](PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR).
- When submitting a PR with changes to user interface (e.g.: new screen, ...), please add screenshots to the PR description.
- When you are finished with your work, please squash your commits otherwise we will squash them on your PR (this can help us maintain a clear commit history).
- When creating an issue to report a bug in the project, please follow our [bug_report.md](https://github.com/anitab-org/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md) template.
- Issues labeled as “First Timers Only” are meant for contributors who have not contributed to the project yet. Please choose other issues to contribute to, if you have already contributed to these type of issues.

## General Guidelines

* If you’re just getting started work on an issue labeled “First Timers Only” in any project. Additional resources are available on our [website](http://www.systers.io).
* In an active repository (not an archived one), choose an open issue from the issue list, claim it in the comments, and a maintainer will assign it to you.
* After approval you must make continuous notes on your progress in the issue while working. If there is not at least one comment every 3 days, the maintainer can reassign the issue.
* Create a branch specific to the issue you're working on, so that you send a PR from that branch instead of the base branch on your fork.
* If you’d like to create a new issue, please go through our issue list first (open as well as closed) and make sure the issues you are reporting do not replicate the existing issues.
* Have a short description on what has gone wrong (like a root cause analysis and description of the fix), if that information is not already present in the issue.
* If you have issues on multiple pages, report them separately. Do not combine them into a single issue.
- If you’re just getting started work on an issue labeled “First Timers Only” in any project. Additional resources are available on our [website](http://www.systers.io).
- In an active repository (not an archived one), choose an open issue from the issue list, claim it in the comments, and a maintainer will assign it to you.
- After approval you must make continuous notes on your progress in the issue while working. If there is not at least one comment every 3 days, the maintainer can reassign the issue.
- Create a branch specific to the issue you're working on, so that you send a PR from that branch instead of the base branch on your fork.
- If you’d like to create a new issue, please go through our issue list first (open as well as closed) and make sure the issues you are reporting do not replicate the existing issues.
- Have a short description on what has gone wrong (like a root cause analysis and description of the fix), if that information is not already present in the issue.
- If you have issues on multiple pages, report them separately. Do not combine them into a single issue.
22 changes: 11 additions & 11 deletions .github/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Hello Newcomer, here are some tips to help you get started contributing to this

Here's what you can do to know more about the project:

* Read Documentation available on [GitHub Wiki](https://github.com/anitab-org/bridge-in-tech-web/wiki) and [README](https://github.com/anitab-org/bridge-in-tech-web);
* You can join the [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech) channel on [AnitaB.org Open Source Zulip](https://anitab-org.zulipchat.com), to see or participate in the project's discussion;
* You can browse the code on GitHub or even on your workspace after [cloning it](https://github.com/anitab-org/bridge-in-tech-web/wiki/Fork,-Clone-&-Remote#clone).
- Read Documentation available on [GitHub Wiki](https://github.com/anitab-org/bridge-in-tech-web/wiki) and [README](https://github.com/anitab-org/bridge-in-tech-web);
- You can join the [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech) channel on [AnitaB.org Open Source Zulip](https://anitab-org.zulipchat.com), to see or participate in the project's discussion;
- You can browse the code on GitHub or even on your workspace after [cloning it](https://github.com/anitab-org/bridge-in-tech-web/wiki/Fork,-Clone-&-Remote#clone).

## Choose a working item

Expand All @@ -31,15 +31,15 @@ In short:
1. Make sure when you finish your changes you squash your commits into a single commit;
1. Once the reviewers approve your PR, they can merge and your code will finally be part of the main repository!


# Other ways to contribute

Do you know there are also other ways to contribute to the project besides working on an issue?
Do you know there are also other ways to contribute to the project besides working on an issue?
As contributors, you can also:
* 👀 **help review a PR** either by looking into the code and ensure that the code is clean and its logic makes sense. You can also run the app from PR branch to ensure the code works. Look for the PRs with `Status: Needs Review` label on the [Backend](https://github.com/anitab-org/bridge-in-tech-backend/pulls) and [Frontend](https://github.com/anitab-org/bridge-in-tech-web/pulls) repositories.
* 💻 **test a PR** by running it manually on your local machine and write a report on whether or not the PR works. Find a PR with `Status: Needs testing` label which is the next step after that PR is approved by the reviewer/s. Here're good examples of testing report done on one of the [backend](https://github.com/anitab-org/bridge-in-tech-backend/pull/71#pullrequestreview-445274875) and [frontend](https://github.com/anitab-org/bridge-in-tech-web/pull/62#pullrequestreview-464955571) PRs.
* 🔨 try to **break the app** by testing the application that runs from the existing code on the develop branch to find any bugs. If you find any, check if there is an issue already open for it, if there's none, report it on the [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech) channel under `Bugs and Fixes` topic to ask if you can open one.
* 📚 **check documentations** and see if any area could be improved to help contributors understand the project better. If you find something, check if there is an issue already open for it, if there's none, report it on the [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech) channel under `Documentation` topic to get approval to open an issue.
* 🎨 give suggestions on how to **improve the UI design**. Post your suggestion for a discussion on the [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech) channel under `Design/Mocks` topic. You might get approval to work on your proposed design and have it implemented as the app UI 😁.

✨ Happy Coding !!! ✨
- 👀 **help review a PR** either by looking into the code and ensure that the code is clean and its logic makes sense. You can also run the app from PR branch to ensure the code works. Look for the PRs with `Status: Needs Review` label on the [Backend](https://github.com/anitab-org/bridge-in-tech-backend/pulls) and [Frontend](https://github.com/anitab-org/bridge-in-tech-web/pulls) repositories.
- 💻 **test a PR** by running it manually on your local machine and write a report on whether or not the PR works. Find a PR with `Status: Needs testing` label which is the next step after that PR is approved by the reviewer/s. Here're good examples of testing report done on one of the [backend](https://github.com/anitab-org/bridge-in-tech-backend/pull/71#pullrequestreview-445274875) and [frontend](https://github.com/anitab-org/bridge-in-tech-web/pull/62#pullrequestreview-464955571) PRs.
- 🔨 try to **break the app** by testing the application that runs from the existing code on the develop branch to find any bugs. If you find any, check if there is an issue already open for it, if there's none, report it on the [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech) channel under `Bugs and Fixes` topic to ask if you can open one.
- 📚 **check documentations** and see if any area could be improved to help contributors understand the project better. If you find something, check if there is an issue already open for it, if there's none, report it on the [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech) channel under `Documentation` topic to get approval to open an issue.
- 🎨 give suggestions on how to **improve the UI design**. Post your suggestion for a discussion on the [#bridge-in-tech](https://anitab-org.zulipchat.com/#narrow/stream/237630-bridge-in-tech) channel under `Design/Mocks` topic. You might get approval to work on your proposed design and have it implemented as the app UI 😁.

✨ Happy Coding !!! ✨
Loading