diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..4a7ea303 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4c4014b3..2fe86100 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,35 +1,42 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -### 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 '....' -4. See error - -### Expected behavior -A clear and concise description of what you expected to happen. - -### Screenshots -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] - -### 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] - -### Additional context -Add any other context about the problem here. +--- +name: Bug report +about: Create a report to help us improve +--- + +### 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 '....' +4. See error + +### Expected behavior + +A clear and concise description of what you expected to happen. + +### Screenshots + +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] + +### 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] + +### Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 8ca8405f..c05a7908 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,17 +1,20 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -### Is your feature request related to a problem? Please describe. -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -### Describe the solution you'd like -A clear and concise description of what you want to happen. - -### Describe alternatives you've considered -A clear and concise description of any alternative solutions or features you've considered. - -### Additional context -Add any other context or screenshots about the feature request here. +--- +name: Feature request +about: Suggest an idea for this project +--- + +### Is your feature request related to a problem? Please describe. + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +### Describe the solution you'd like + +A clear and concise description of what you want to happen. + +### Describe alternatives you've considered + +A clear and concise description of any alternative solutions or features you've considered. + +### Additional context + +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/user-story.md b/.github/ISSUE_TEMPLATE/user-story.md index 61ceb97d..6cf64ff9 100644 --- a/.github/ISSUE_TEMPLATE/user-story.md +++ b/.github/ISSUE_TEMPLATE/user-story.md @@ -1,26 +1,33 @@ ---- -name: User story -about: Create your development plans and work tasks here. - ---- - -## Description -As a [USER], -I need [TO DO THIS], -so that I can [ACCOMPLISH THAT]. - -## Mocks -[INSERT RELEVANT PNG FILE] - -## Acceptance Criteria -### Update [Required] -- [ ] [LIST ITEMS] -### Enhancement to Update [Optional] -- [ ] [LIST ITEMS] - -## Definition of Done -- [ ] All of the required items are completed. -- [ ] Approval by 1 mentor. - -## Estimation -[INSERT NUMBER HERE] hours +--- +name: User story +about: Create your development plans and work tasks here. +--- + +## Description + +As a [USER], +I need [TO DO THIS], +so that I can [ACCOMPLISH THAT]. + +## Mocks + +[INSERT RELEVANT PNG FILE] + +## Acceptance Criteria + +### Update [Required] + +- [ ] [LIST ITEMS] + +### Enhancement to Update [Optional] + +- [ ] [LIST ITEMS] + +## Definition of Done + +- [ ] All of the required items are completed. +- [ ] Approval by 1 mentor. + +## Estimation + +[INSERT NUMBER HERE] hours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6fdec4f5..afa7b3fc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,6 +5,7 @@ Include a summary of the change and relevant motivation/context. List any depend Fixes # [ISSUE] ### Type of Change: + **Delete irrelevant options.** - Code @@ -14,18 +15,18 @@ Fixes # [ISSUE] - Documentation **Code/Quality Assurance Only** + - Bug fix (non-breaking change which fixes an issue) - This change requires a documentation update (software upgrade on readme file) - New feature (non-breaking change which adds functionality pre-approved by mentors) - - ### How Has This Been Tested? + If you are working on a design then add a gif to show the responsiveness of your design. Please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR) and share the link of deployed site here. - ### Checklist: + **Delete irrelevant options.** - [ ] My PR follows the style guidelines of this project @@ -35,8 +36,8 @@ Please follow [testing guidelines](https://github.com/anitab-org/anitab-org.gith - [ ] I have attached link of deployed site. - [ ] Any dependent changes have been merged - **Code/Quality Assurance Only** + - [ ] My changes generate no new warnings - [ ] My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected) - [ ] I have added tests that prove my fix is effective or that my feature works diff --git a/.github/config.yml b/.github/config.yml index 09c41ab0..fd5f6ed9 100644 --- a/.github/config.yml +++ b/.github/config.yml @@ -36,4 +36,4 @@ welcomeMessage: > You may submit a PR on the same if you like! If you want to report a bug 🐞 & please follow our [Bug_Report.md](https://github.com/anitab-org/anitab-org.github.io/blob/develop/docs/.github/ISSUE_TEMPLATE/bug_report.md/) template. Also please make sure you include steps to reproduce it and be patient we will get back to you as soon as we can.👀 Also feel free to join us on [AnitaB.org Open Source Zulip Community](https://anitab-org.zulipchat.com/login/)🤝. We have different streams for each active repo's for discussions. - Hope you have a great time here :) \ No newline at end of file + Hope you have a great time here :) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 4fcbf36a..516fdf9f 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,26 +1,37 @@ # This is a basic workflow to help you get started with Actions name: Build and Deploy to GitHub static pages -# Controls when the action will run. +# Controls when the action will run. on: - # Triggers the workflow on push or pull request events but only for the develop branch + # Triggers the workflow on push or pull request events but only for pushes on the develop branch + pull_request: push: - branches: [ develop ] + branches: [develop] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: - # This workflow contains a single job called "build" + # This workflow formats the code with our linter (Prettier) and then builds + prettier: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Prettify code + uses: creyD/prettier_action@v4.0 build: # The type of runner that the job will run on + if: github.event_name != 'pull_request' runs-on: ubuntu-latest # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - + - name: Checkout 🛎️ uses: actions/checkout@v2.3.1 # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly. with: diff --git a/.github/workflows/pr-check.yml b/.github/workflows/pr-check.yml new file mode 100644 index 00000000..1e2a2b93 --- /dev/null +++ b/.github/workflows/pr-check.yml @@ -0,0 +1,30 @@ +name: PR Safe Check + +on: + pull_request: + branches: [ develop ] + types: [opened, synchronize, reopened] + push: + branches: [ develop ] + +jobs: + build_check: + + runs-on: ubuntu-latest + strategy: + matrix: + node: [ '14', '16' ] + name: Node.js v${{ matrix.node }} + steps: + - name: 🛎 Checkout + uses: actions/checkout@v2 + - name: 🚀 Use Node.js + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node }} + - name: ⚙️ Install dependencies + run: npm install + - name: 🔍 Run tests + run: npm test + - name: 🔨 Build the project + run: npm run build diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 00000000..0c43a1c6 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,21 @@ +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# production +/build + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/.prettierrc.json b/.prettierrc.json new file mode 100644 index 00000000..544138be --- /dev/null +++ b/.prettierrc.json @@ -0,0 +1,3 @@ +{ + "singleQuote": true +} diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 8557c4aa..00000000 --- a/.travis.yml +++ /dev/null @@ -1,23 +0,0 @@ -language: node_js -node_js: - - 12.0.0 - -before_deploy: - - nvm install 12 - - yarn && yarn build - -before_deploy: - - yarn - - yarn build - -deploy: - -# production - provider: pages - skip_cleanup: true - github_token: $GITHUB_API_KEY - keep_history: true - local_dir: './build/' - target_branch: 'master' - on: - branch: production diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index b2674f57..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,23 +0,0 @@ -# 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). anitab-org.github.io stream is [#anitab-org.github.io](https://anitab-org.zulipchat.com/#narrow/stream/235478-anitab-org.2Egithub.2Eio). -* 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/mentorship-android/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/anitab-org.github.io/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](.github/PULL_REQUEST_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](.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. -* 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. - diff --git a/README.md b/README.md index ef979a4e..19eb2cd2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - [![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://anitab-org.zulipchat.com/#narrow/stream/235478-anitab-org.2Egithub.2Eio) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) ![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102) @@ -7,8 +6,6 @@ [![GitHub forks](https://img.shields.io/github/forks/Naereen/StrapDown.js.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/anitab-org/anitab-org.github.io/network/members) [![GitHub stars](https://img.shields.io/github/stars/Naereen/StrapDown.js.svg?style=social&label=Star&maxAge=2592000)](https://github.com/anitab-org/anitab-org.github.io/stargazers) - - # anitab-org.github.io This is the main website for **AnitaB.org Open Source**. It contains information about our various open source projects, the programs we participate in, information about how to contribute, and how to contact us.This website acts as an interface to help introduce people to the organization's Open Source community, and make the transition from newcomers to contributors easier. @@ -19,31 +16,31 @@ To setup the project locally follow the instructions: #### Fork -_**Note**_: *This is only needed if you want to contribute to the project.* +_**Note**_: _This is only needed if you want to contribute to the project._ If you want to contribute to the project you will have to create your own copy of the project on GitHub. You can do this by clicking the Fork button that can be found on the top right corner of the [landing page](https://github.com/anitab-org/anitab-org.github.io) of the repository. #### Clone -_**Note**_: *For this you need to install git on your machine. You can download the git tool from [here](https://git-scm.com/downloads).* +_**Note**_: _For this you need to install git on your machine. You can download the git tool from [here](https://git-scm.com/downloads)._ + +- If you have forked the project, run the following command - - * If you have forked the project, run the following command - - - `git clone https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io` + `git clone https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io` - where `YOUR_GITHUB_USER_NAME` is your GitHub handle. + where `YOUR_GITHUB_USER_NAME` is your GitHub handle. - * If you haven't forked the project, run the following command - +- If you haven't forked the project, run the following command - - `git clone https://github.com/anitab-org/anitab-org.github.io` - - * Now after you cloned the repository, get into the anitab-org.github.io directory by - + `git clone https://github.com/anitab-org/anitab-org.github.io` - `cd anitab-org.github.io` +- Now after you cloned the repository, get into the anitab-org.github.io directory by - + + `cd anitab-org.github.io` #### Remote -_**Note**_: *This is only needed if you want to contribute to the project.* +_**Note**_: _This is only needed if you want to contribute to the project._ When a repository is cloned, it has a default remote named `origin` that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named upstream. For this project it can be done by running the following command - @@ -59,24 +56,21 @@ upstream https://github.com/anitab-org/anitab-org.github.io.git (fetch) upstream https://github.com/anitab-org/anitab-org.github.io.git (push) ``` - ### Run app Download the latest stable version of NodeJs [here](https://nodejs.org/en/download/) and install it. Install `yarn`. Run `node --version` and `yarn --version` to verify successful installation. To get the frontend running locally: - * Clone this repository - * `yarn` to install all required dependencies - * `yarn start` to start the local server - - - ## Prerequisites - - **Javascript** - We are using technologies such as javascript , HTML , CSS for our website AnitaB.org Open Source. - - **React-Native** - As our Whole content is written in react native so we can easly transform this into native apps in future. +- Clone this repository +- `yarn` to install all required dependencies +- `yarn start` to start the local server + +## Prerequisites + +**Javascript** - We are using technologies such as javascript , HTML , CSS for our website AnitaB.org Open Source. +**ReactJS** - As our Whole content is written in ReactJS so we can easly transform this into native apps in future. ## Contributing diff --git a/Wiki.md b/Wiki.md index a30ae6e4..3227a39a 100644 --- a/Wiki.md +++ b/Wiki.md @@ -2,21 +2,20 @@ _**Note**: This is only needed if you want to contribute to the project._ -If you want to contribute to the project you will have to create your own copy of the project on GitHub. You can do this by clicking the -**Fork** button that can be found on the top right corner of the [landing page]([https://github.com/anitab-org/anitab-org.github.io]) of the repository. - +If you want to contribute to the project you will have to create your own copy of the project on GitHub. You can do this by clicking the +**Fork** button that can be found on the top right corner of the [landing page]([https://github.com/anitab-org/anitab-org.github.io]) of the repository. ## [](https://github.com/anitab-org/anitab-org.github.io/wiki/Fork,-Clone-&-Remote#clone)Clone -_**Note**: For this you need to install [git](https://git-scm.com/) on your machine. You can download the git tool from [here](https://git-scm.com/downloads)._ +_**Note**: For this you need to install [git](https://git-scm.com/) on your machine. You can download the git tool from [here](https://git-scm.com/downloads)._ -- If you have forked the project, run the following command - +- If you have forked the project, run the following command - `git clone https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io` -where `YOUR_GITHUB_USER_NAME` is your GitHub handle. +where `YOUR_GITHUB_USER_NAME` is your GitHub handle. -- If you haven't forked the project, run the following command - +- If you haven't forked the project, run the following command - `git clone https://github.com/anitab-org/anitab-org.github.io` @@ -24,11 +23,11 @@ where `YOUR_GITHUB_USER_NAME` is your GitHub handle. _**Note**: This is only needed if you want to contribute to the project._ -When a repository is cloned, it has a default remote named `origin` that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named upstream. For this project it can be done by running the following command - +When a repository is cloned, it has a default remote named `origin` that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named upstream. For this project it can be done by running the following command - `git remote add upstream https://github.com/anitab-org/anitab-org.github.io` -You can check that the previous command worked by running `git remote -v`. You should see the following output: +You can check that the previous command worked by running `git remote -v`. You should see the following output: ``` $ git remote -v @@ -37,13 +36,15 @@ origin https://github.com/YOUR_GITHUB_USER_NAME/anitab-org.github.io (push) upstream https://github.com/anitab-org/anitab-org.github.io.git (fetch) upstream https://github.com/anitab-org/anitab-org.github.io.git (push) ``` -## Install -1. Latest stable version of NodeJs [here](https://nodejs.org/en/download/). -2. Install [yarn]([https://classic.yarnpkg.com/en/docs/install#windows-stable](https://classic.yarnpkg.com/en/docs/install#windows-stable)). -3. Run `node -v` and `yarn -v`. If you get the version number, then the installation was successful. + +## Install + +1. Latest stable version of NodeJs [here](https://nodejs.org/en/download/). +2. Install [yarn](<[https://classic.yarnpkg.com/en/docs/install#windows-stable](https://classic.yarnpkg.com/en/docs/install#windows-stable)>). +3. Run `node -v` and `yarn -v`. If you get the version number, then the installation was successful. To get the frontend running locally: -- Clone this repository -- `yarn` to install all required dependencies -- `yarn start` or `npm start` to start the local server +- Clone this repository +- `yarn` to install all required dependencies +- `yarn start` or `npm start` to start the local server diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index eb27a177..53ba3f4e 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,24 +1,23 @@ # 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). anitab-org.github.io stream is [#anitab-org.github.io](https://anitab-org.zulipchat.com/#narrow/stream/235478-anitab-org.2Egithub.2Eio). -* 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/mentorship-android/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/anitab-org.github.io/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](.github/PULL_REQUEST_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 submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR. -* 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](.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). anitab-org.github.io stream is [#anitab-org.github.io](https://anitab-org.zulipchat.com/#narrow/stream/235478-anitab-org.2Egithub.2Eio). +- 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/mentorship-android/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/anitab-org.github.io/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](.github/PULL_REQUEST_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 submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR. +- 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](.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. -* 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. +- 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. diff --git a/docs/code_of_conduct.md b/docs/code_of_conduct.md index 4d78e824..5b8d6b1e 100644 --- a/docs/code_of_conduct.md +++ b/docs/code_of_conduct.md @@ -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 @@ -52,9 +52,8 @@ 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. @@ -62,7 +61,6 @@ Additionally, community admins are available to help community members engage wi 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. @@ -80,4 +78,3 @@ This Code of Conduct is distributed under a [Creative Commons Attribution-ShareA Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy). Retrieved on November 22, 2016 from [http://citizencodeofconduct.org/](http://citizencodeofconduct.org/) - diff --git a/docs/reporting_guidelines.md b/docs/reporting_guidelines.md index c5e34e96..71cf093b 100644 --- a/docs/reporting_guidelines.md +++ b/docs/reporting_guidelines.md @@ -8,17 +8,15 @@ If you believe anyone is in physical danger, please notify appropriate emergency In your report please include: -* Your contact info for follow-up contact. -* Names (legal, nicknames, or pseudonyms) of any individuals involved. -* If there were other witnesses besides you, please try to include them as well. -* When and where the incident occurred. Please be as specific as possible. -* Your account of what occurred. -* If there is a publicly available record (e.g. a mailing list archive or a public IRC logger) please include a link. -* Any extra context you believe existed for the incident. -* If you believe this incident is ongoing. -* Any other information you believe we should have. - - +- Your contact info for follow-up contact. +- Names (legal, nicknames, or pseudonyms) of any individuals involved. +- If there were other witnesses besides you, please try to include them as well. +- When and where the incident occurred. Please be as specific as possible. +- Your account of what occurred. +- If there is a publicly available record (e.g. a mailing list archive or a public IRC logger) please include a link. +- Any extra context you believe existed for the incident. +- If you believe this incident is ongoing. +- Any other information you believe we should have. ## What happens after you file a report? @@ -26,29 +24,27 @@ You will receive an email from the AnitaB.org Open Source's Code of Conduct resp The working group will immediately meet to review the incident and determine: -* What happened. -* Whether this event constitutes a code of conduct violation. -* What kind of response is appropriate. +- What happened. +- Whether this event constitutes a code of conduct violation. +- What kind of response is appropriate. If this is determined to be an ongoing incident or a threat to physical safety, the team's immediate priority will be to protect everyone involved. This means we may delay an "official" response until we believe that the situation has ended and that everyone is physically safe. Once the team has a complete account of the events they will make a decision as to how to respond. Responses may include: Nothing (if we determine no code of conduct violation occurred). -* A private reprimand from the Code of Conduct response team to the individual(s) involved. -* A public reprimand. -* An imposed vacation (i.e. asking someone to "take a week off" from a mailing list or IRC). -* A permanent or temporary ban from some or all of AnitaB.org spaces (events, meetings, mailing lists, IRC, etc.) -* A request to engage in mediation and/or an accountability plan. -We'll respond within one week to the person who filed the report with either a resolution or an explanation of why the situation is not yet resolved. + +- A private reprimand from the Code of Conduct response team to the individual(s) involved. +- A public reprimand. +- An imposed vacation (i.e. asking someone to "take a week off" from a mailing list or IRC). +- A permanent or temporary ban from some or all of AnitaB.org spaces (events, meetings, mailing lists, IRC, etc.) +- A request to engage in mediation and/or an accountability plan. + We'll respond within one week to the person who filed the report with either a resolution or an explanation of why the situation is not yet resolved. Once we've determined our final action, we'll contact the original reporter to let them know what action (if any) we'll be taking. We'll take into account feedback from the reporter on the appropriateness of our response, but our response will be determined by what will be best for community safety. Finally, the response team will make a report on the situation to the AnitaB.org's Open Source Board. The board may choose to issue a public report of the incident or take additional actions. - - ## Appealing the response Only permanent resolutions (such as bans) may be appealed. To appeal a decision of the working group, contact the community admins at opensource@anitab.org with your appeal and we will review the case. - diff --git a/package.json b/package.json index dc4482fd..f413f4bf 100644 --- a/package.json +++ b/package.json @@ -10,6 +10,7 @@ "dayjs": "^1.9.3", "react": "^16.13.1", "react-dom": "^16.13.1", + "react-native-hyperlink": "0.0.19", "react-native-reflect": "^0.1.6", "react-native-web": "^0.12.2", "react-scripts": "^3.4.1" @@ -39,6 +40,7 @@ }, "devDependencies": { "@testing-library/react": "^11.2.2", - "gh-pages": "^2.2.0" + "gh-pages": "^2.2.0", + "prettier": "2.4.1" } } diff --git a/public/index.html b/public/index.html index 4b6e3042..285ced49 100644 --- a/public/index.html +++ b/public/index.html @@ -19,10 +19,7 @@ itemprop="description" content="AnitaB.org Open Source aims to provide women of all skill levels and backgrounds with the opportunity to collaborate and develop open source projects with the aspirations of social good." /> - + @@ -48,10 +45,7 @@ property="og:description" content="AnitaB.org Open Source aims to provide women of all skill levels and backgrounds with the opportunity to collaborate and develop open source projects with the aspirations of social good." /> - +