diff --git a/.github/ISSUE_TEMPLATE/bug-report---bot-implementation.md b/.github/ISSUE_TEMPLATE/bug-report---bot-implementation.md index 82aee2e9..ba69e407 100644 --- a/.github/ISSUE_TEMPLATE/bug-report---bot-implementation.md +++ b/.github/ISSUE_TEMPLATE/bug-report---bot-implementation.md @@ -25,14 +25,14 @@ 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] + - 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] + - 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/bug-report---vostptia.md b/.github/ISSUE_TEMPLATE/bug-report---vostptia.md index 8265973b..7e63f853 100644 --- a/.github/ISSUE_TEMPLATE/bug-report---vostptia.md +++ b/.github/ISSUE_TEMPLATE/bug-report---vostptia.md @@ -1,7 +1,6 @@ --- name: Bug report - VOSTPTia -about: Choose this option if you spotted a bug in a VOST PT, VOST Europe, or related - social media accounts, and you think it was originated by VOSTPTia bot +about: Choose this option if you spotted a bug in a VOST PT, VOST Europe, or related social media accounts, and you think it was generated by the VOSTPTia bot title: "[BUG] New bug in VOSTPTia" labels: bug assignees: '' @@ -11,8 +10,8 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. -**Where did you see the bug** -The account or page where you spotted the bug. If possible, put the link to the affected post (e.g. "VOST PT Twitter account - https://twitter.com/VOSTPT/status/1377970487188410368"). +**Where did you find the bug** +The account or page where you spotted the bug. If possible, include the link to the affected post (e.g. "VOST PT Twitter account - https://twitter.com/VOSTPT/status/1377970487188410368"). **Expected behavior** A clear and concise description of what you expected to happen. @@ -22,14 +21,14 @@ 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] + - 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] + - 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 5fcea0ab..0eca8087 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,6 @@ --- name: Feature request -about: Choose this option if you want to suggest an idea to implement in the bot +about: Choose this option if you want to suggest an idea for the bot title: "[FEAT] New feature request" labels: enhancement assignees: '' @@ -8,7 +8,7 @@ assignees: '' --- **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 [...] +A clear and concise description of what the problem is. E.g. I'm always frustrated when [...] **Describe the solution you'd like** A clear and concise description of what you want to happen. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78ba5dda..37db4ffd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,29 +1,29 @@ # Contributing -First and foremost, we appreciate your interest in this project. This document contains essential information, should you want to contribute. +First and foremost, we appreciate your interest in this project. This document contains essential information if you want to contribute. ## Development discussion For bugs, new features or improvements, open a new [issue](https://github.com/vostpt/bot/issues/new). ## Which Branch? -Pull requests should always be done against the `master` branch. +Pull requests should always target the `master` branch. ## Coding Style -This project follows the [AirBnb JS styleguide](https://github.com/airbnb/javascript) coding style guide. +This project follows the [Airbnb JavaScript style guide](https://github.com/airbnb/javascript). -### Javascript ESLint -An [ESLint](https://eslint.org/) script is hooked into the CI pipeline, so you'll be notified of any coding standard issue when pushing code. +### JavaScript ESLint +An [ESLint](https://eslint.org/) script is hooked into the CI pipeline, so you'll be notified of any coding standards issues when pushing code. #### Check On each build, the `lint` npm script is executed to make sure the coding standards are followed. #### Fix -If the build breaks due to coding standards, the following command fixes the issues: +If the build breaks due to coding standards, the following command can fix the issues: ```sh ./node_modules/.bin/eslint --fix ``` -Although is advisable to fix the issues by hand to build awareness for the future. Doing it by hand trains our brain to not commit those kind of issues again. +Although it is advisable to fix issues by hand to build awareness for the future. Doing it by hand trains us to avoid committing those kinds of issues again. ### PHPDoc The following is a valid documentation block example: @@ -60,6 +60,6 @@ feat(Occurrences): implement API client to fetch occurrence data ## Branching strategy We will be using the **branch-per-issue** workflow. -This means, that for each open [issue](https://github.com/vostpt/bot/issues), we'll create a corresponding **git** branch. +This means that for each open [issue](https://github.com/vostpt/bot/issues), we'll create a corresponding **git** branch. For instance, issue `#123` should have a corresponding `BOT-123/ShortTaskDescription` branch, which **MUST** branch off the latest code in `master`. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index ec15f70c..fb00c8e8 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -5,16 +5,16 @@ Use the following title format: [BOT-XYZ] ## Description This pull request addresses issue [BOT-XYZ](https://github.com/vostpt/bot/issues/XYZ). -## Task items: +## Task items - [ ] Fixed issue X; - [ ] Added feature Y; - [ ] Updated the documentation for Z; - [ ] Increased test coverage for W; -- [ ] Other task related item; +- [ ] Other task-related item; - [ ] ... ## Requirements (optional) -Requirements when deploying the current work to an environment (`dev`, `staging` or `production`): +Requirements for deploying this work to an environment (`dev`, `staging` or `production`): - An `ENV` variable needs to be added; - Permissions need to be set for `X`, `Y` and `Z`; diff --git a/README.md b/README.md index fd7d35fc..27e7d9e7 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ BOT_TOKEN= COOLDOWN= # -# The channels to where messages should be sent +# The channels where messages should be sent # MAIN_CHANNEL_ID= EARTHQUAKES_CHANNEL_ID= @@ -210,7 +210,7 @@ BSKY_PASS= BSKY_REPOHANDLE= ``` -You will also need a `data/auth/vostpt-bot.json` config (can be test version). +You will also need a `data/auth/vostpt-bot.json` config file (a test version is acceptable). # Running If you went through the previous steps successfully, you should now be able to run **VOSTPT Discord bot** with the following command: @@ -219,7 +219,7 @@ If you went through the previous steps successfully, you should now be able to r npm start ``` -Tip: use the `BETA_MODE` env variable to toggle which function in [src/jobs/index.json](src/jobs/index.js) is executed `startProd` (`BETA_MODE=false`) for production and `startBeta` (`BETA_MODE=true`). +Tip: use the `BETA_MODE` env variable to choose which function in [src/jobs/index.js](src/jobs/index.js) is executed: `startProd` (`BETA_MODE=false`) for production or `startBeta` (`BETA_MODE=true`). You should see an output similar to this: diff --git a/docs/README.md b/docs/README.md index 72c0e6bd..ec2ad61d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,9 +15,9 @@ npm install ``` ## Configuração -Após instalar, it's time for a quick configuration. +Após instalar as dependências, é altura de fazer uma configuração rápida. -Cria um ficheiro `.env` na raíz do projeto. +Cria um ficheiro `.env` na raiz do projeto. ```sh cp .env.example .env @@ -50,13 +50,13 @@ TWITTER_ACCESS_TOKEN_SECRET= ``` ## Arrancar o bot -Se já percorreste todos os passos anteriores deves estar tudo pronto para arrancar o bot. Para isso basta executar: +Se já percorreste todos os passos anteriores, deves ter tudo pronto para arrancar o bot. Para isso, basta executar: ```sh npm start ``` -E deve aparecer algo do género no terminal: +Deve aparecer algo do género no terminal: ```sh READY :: Bot started @ 2019-4-14 21:27:00 ``` diff --git a/docs/en/README.md b/docs/en/README.md index f07b3a34..a34e1ad9 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -23,7 +23,7 @@ Create a `.env` file in the project root. cp .env.example .env ``` -Add and replace values where needed: +Add or replace values where needed: ``` # @@ -32,7 +32,7 @@ Add and replace values where needed: BOT_TOKEN= # -# The channels to where messages should be sent +# The channels where messages should be sent # MAIN_CHANNEL_ID= EARTHQUAKES_CHANNEL_ID= diff --git a/docs/pt/theme/index.js b/docs/pt/theme/index.js index 77151a4f..af15d208 100644 --- a/docs/pt/theme/index.js +++ b/docs/pt/theme/index.js @@ -5,7 +5,7 @@ module.exports = { lastUpdated: 'Última atualização', editLinkText: 'Ajuda-nos a melhorar!', nav: [ - { text: 'Inicio', link: '/' }, + { text: 'Início', link: '/' }, { text: 'Junta-te a nós!', link: 'https://docs.google.com/forms/d/e/1FAIpQLSf6PgIPl4XrAkGLYnPOJ2KSu2cujzSBg9XiKcfG7QHoHAZgFA/viewform' }, ], };