Skip to content

Commit

Permalink
Remove now uneeded utils script and update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtavis committed Feb 9, 2025
1 parent 57e8c5d commit 5c6c3f6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 115 deletions.
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ If you have questions or would like to communicate with the team, please [join u
- [Learning the tech stack](#learning-the-tech-)
- [Development environment](#dev-env-)
- [Style guide](#style-guide-)
- [Testing](#testing-)
- [Linting](#linting-)
- [Testing](#testing-)
- [Issues and projects](#issues-projects-)
- [Bug reports](#bug-reports-)
- [Feature requests](#feature-requests-)
Expand Down Expand Up @@ -57,11 +57,11 @@ The following are the current and planned technologies for [activist.org](https:

### Backend

- [Django](https://www.djangoproject.com)[PostgreSQL](https://www.postgresql.org) (planned)
- [Django](https://www.djangoproject.com)[PostgreSQL](https://www.postgresql.org)

### Deployment

- [Docker](https://www.docker.com)[Netlify](https://www.netlify.com)[Vitest](https://vitest.dev/) (planned)
- [Docker](https://www.docker.com)[Netlify](https://www.netlify.com)[Vitest](https://vitest.dev/)

### Localization

Expand Down Expand Up @@ -343,6 +343,14 @@ From there you'll be able to visit http://localhost:6006/ to view the documentat

Please see the [activist style guide](STYLEGUIDE.md) for details about how to follow the code style for the project. We made these guidelines to assure that we as a community write clean, cohesive code that's easy to write and review. Suggestions for the style guide are welcome.
<a id="linting-"></a>
## Linting [`⇧`](#contents)
For the backend [Ruff](https://github.com/astral-sh/ruff) is installed via the required packages to assure that errors are reported correctly. We'd also suggest that VS Code users install the [Ruff extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff).

For the frontend [eslint](https://eslint.org/), [eslint-vue](https://eslint.vuejs.org/) and [vue-a11y](https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/) are added via the dependencies to provide linting support.

<a id="testing-"></a>

## Testing [`⇧`](#contents)
Expand Down Expand Up @@ -395,7 +403,7 @@ yarn typecheck
#### Automated Testing
We use vitest for component and unit testing. You can run them with the following command:
We use [Vitest](https://vitest.dev/) for component and unit testing. You can run them with the following command:
```bash
# Within ./frontend:
Expand All @@ -405,7 +413,7 @@ yarn test
Please see the [frontend testing guide](FRONTEND_TESTING.md) for information on how to write component tests.
> [!NOTE]
> The vitest test suite is still in a very early stage. There is a lot of work left to do to increase test coverage, and some features still need troubleshooting. If you need assistance then feel free to open a PR and we'll support!
> The Vitest test suite is still in a very early stage. There is a lot of work left to do to increase test coverage, and some features still need troubleshooting. If you need assistance then feel free to open a PR and we'll support!

### End to End Testing

Expand Down Expand Up @@ -477,14 +485,6 @@ You can then visit the [actions of the repository](https://github.com/activist-o

Thank you for testing your PRs! 🎉

<a id="linting-"></a>

## Linting [`⇧`](#contents)

For the backend [Ruff](https://github.com/astral-sh/ruff) is installed via the required packages to assure that errors are reported correctly. We'd also suggest that VS Code users install the [Ruff extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff).
For the frontend [eslint](https://eslint.org/), [eslint-vue](https://eslint.vuejs.org/) and [vue-a11y](https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/) are added via the dependencies to provide linting support.
<a id="issues-projects"></a>

## Issues and projects [`⇧`](#contents)
Expand Down
102 changes: 0 additions & 102 deletions utils/check_license.py

This file was deleted.

0 comments on commit 5c6c3f6

Please sign in to comment.