-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5033 from specify/prettier-3
chore: Update to Prettier 3
- Loading branch information
Showing
219 changed files
with
1,794 additions
and
1,669 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,9 @@ repos: | |
- id: mypy | ||
name: mypy | ||
description: Python mypy typechecker | ||
entry: /bin/bash -c "docker exec --tty specify7_specify7_1 bash -c 'VIRTUAL_ENV=./ve make typecheck'" | ||
entry: | ||
/bin/bash -c "docker exec --tty specify7_specify7_1 bash -c | ||
'VIRTUAL_ENV=./ve make typecheck'" | ||
language: script | ||
types: [python] | ||
pass_filenames: false | ||
|
@@ -115,7 +117,7 @@ repos: | |
- id: prettier | ||
additional_dependencies: | ||
- [email protected] | ||
- "@prettier/plugin-xml@^0.13.1" | ||
- '@prettier/plugin-xml@^0.13.1' | ||
- prettier-plugin-package@^1.3.0 | ||
- prettier-plugin-sh@^0.8.1 | ||
- prettier-plugin-tailwind-css@^1.5.0 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
cff-version: 1.2.0 | ||
message: "If you use this software in your research, please cite it as:" | ||
message: 'If you use this software in your research, please cite it as:' | ||
authors: | ||
- name: Specify Collections Consortium & Contributors | ||
email: [email protected] | ||
|
@@ -12,12 +12,8 @@ identifiers: | |
value: 'https://www.specifysoftware.org/' | ||
description: Specify Collections Consortium | ||
abstract: >- | ||
The Specify Collections Consortium research repositories | ||
produce software platforms that process species and | ||
specimen data. | ||
keywords: | ||
- collections management software | ||
- open source | ||
The Specify Collections Consortium research repositories produce software | ||
platforms that process species and specimen data. | ||
license: GPL-2.0-only | ||
repository-code: specify/specify7 | ||
repository: "https://github.com/specify/specify7" | ||
repository: 'https://github.com/specify/specify7' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,27 +36,25 @@ together to achieve our mission._ | |
|
||
## Getting Started | ||
|
||
Preferred way to do Specify 7 development is though our development | ||
composition. | ||
Preferred way to do Specify 7 development is though our development composition. | ||
|
||
[Documentation for getting development Docker composition | ||
working](https://github.com/specify/specify7/wiki/Docker-Workflow-for-Development) | ||
[Documentation for getting development Docker composition working](https://github.com/specify/specify7/wiki/Docker-Workflow-for-Development) | ||
|
||
## Issue Tracking | ||
|
||
All feature requests and bugs are tracked on GitHub. Each issue is sorted into a | ||
project. Each project represents a major Specify 7 | ||
component. [A list of all projects](https://github.com/specify/specify7/projects?type=classic) | ||
project. Each project represents a major Specify 7 component. | ||
[A list of all projects](https://github.com/specify/specify7/projects?type=classic) | ||
|
||
If you found a bug, feel free to open a GitHub issue. Similarly, if you are | ||
interested in fixing some issue or adding new feature, feel free to do so! | ||
If you want to work on a larger feature, it would be best if you [get in touch | ||
with us](mailto:[email protected]) first so that we can make sure the | ||
process is smooth and efficient. | ||
interested in fixing some issue or adding new feature, feel free to do so! If | ||
you want to work on a larger feature, it would be best if you | ||
[get in touch with us](mailto:[email protected]) first so that we can | ||
make sure the process is smooth and efficient. | ||
|
||
Our entire workflow for reporting bugs, trianging them, prioritizing the fixes, | ||
testing them and releasing the | ||
fixes - https://github.com/specify/specify7/wiki/Issue-Workflow | ||
testing them and releasing the fixes - | ||
https://github.com/specify/specify7/wiki/Issue-Workflow | ||
|
||
You don't have to read every part of that document, but some of the sections in | ||
that document would be relevant | ||
|
@@ -66,12 +64,12 @@ Example workflow: | |
1. Go through GitHub Projects | ||
2. Find a ticket that you are interested in resolving | ||
3. Fix it in a local fork of Specify 7 | ||
4. Open a pull request in Specify 7 repository. In the pull request, mention | ||
the issue you are solving by putting `Fixes #1234` in the description, where | ||
4. Open a pull request in Specify 7 repository. In the pull request, mention the | ||
issue you are solving by putting `Fixes #1234` in the description, where | ||
`1234` is a number of GitHub issue | ||
5. We will review the changes and merge them into next release. You will receive | ||
credit in the release notes! | ||
|
||
### First Steps | ||
|
||
It's recomended to start with issues that are labled with | ||
|
@@ -85,42 +83,42 @@ would prepare you for taking on larger GitHub issues. | |
|
||
On the front-end, we are using TypeScript, React and Tailwind CSS. | ||
|
||
Front-end root directory is | ||
in [./specifyweb/frontend/js_src](https://github.com/specify/specify7/tree/testability/specifyweb/frontend/js_src) | ||
Front-end root directory is in | ||
[./specifyweb/frontend/js_src](https://github.com/specify/specify7/tree/testability/specifyweb/frontend/js_src) | ||
|
||
Each folder and sub-folder has a README.md file that describes the role of that | ||
directory and provides other meta information. | ||
|
||
We have a [video of a full front-end code overview from January 2023 available here](https://drive.google.com/file/d/11TDHSz54EhQ5eQPNyaogHOODO8_8Q9yg/view). | ||
We have a | ||
[video of a full front-end code overview from January 2023 available here](https://drive.google.com/file/d/11TDHSz54EhQ5eQPNyaogHOODO8_8Q9yg/view). | ||
|
||
## Back-End | ||
|
||
Back-end uses Python and Django. It also works closely with a MySQL/MariaDB | ||
database both though Django ORM and though SQLAlchemy. | ||
|
||
Back-end root directory | ||
is [./specifyweb/](https://github.com/specify/specify7/tree/production/specifyweb) | ||
Back-end root directory is | ||
[./specifyweb/](https://github.com/specify/specify7/tree/production/specifyweb) | ||
|
||
[We have a video of a full back-end overview from January 2023 available here](https://drive.google.com/file/d/1OW60g99aiPw1Y8uHdCUxZCiVnLbFhObG/view?usp=sharing) | ||
|
||
## IDE Setup | ||
|
||
No special IDE configuration is required, but some optional plugins would | ||
improve developer | ||
experience - https://github.com/specify/specify7/tree/production/specifyweb/frontend/js_src#js_src | ||
improve developer experience - | ||
https://github.com/specify/specify7/tree/production/specifyweb/frontend/js_src#js_src | ||
|
||
That document includes a short list. For a full list, | ||
see https://github.com/specifysystems/code-principles | ||
That document includes a short list. For a full list, see | ||
https://github.com/specifysystems/code-principles | ||
|
||
In the browser, you can install React Devtools extension to make debugging React | ||
components easier. | ||
|
||
## Code-Style | ||
|
||
We prefer functional programming paradigm. In our opinion, perfect code\* | ||
consist | ||
of small and pure functions that have clear unit tests, and can be combined | ||
together to solve a complex task. | ||
consist of small and pure functions that have clear unit tests, and can be | ||
combined together to solve a complex task. | ||
|
||
> \*no code is perfect, but you can still strive for it | ||
|
@@ -129,8 +127,8 @@ formatting to make code less buggy and more consistent. | |
|
||
Additionally, ESLint goes beyond that to provide close to a thousand of static | ||
analysis checks and quick fixes, all in a name of clear and bug-free code. Our | ||
ESLint configuration is located | ||
in [@maxxxxxdlp/eslint-config-react](https://www.npmjs.com/package/@maxxxxxdlp/eslint-config-react) | ||
ESLint configuration is located in | ||
[@maxxxxxdlp/eslint-config-react](https://www.npmjs.com/package/@maxxxxxdlp/eslint-config-react) | ||
|
||
## Test Panel | ||
|
||
|
@@ -149,22 +147,21 @@ quickly deploy an older version of Specify to compare behavior. | |
|
||
## Support | ||
|
||
A great deal of user-facing documentation is available at | ||
our [Discourse forum](https://discourse.specifysoftware.org/). Most of it is | ||
available to users from member institutions only, thus [consider joining the | ||
Specify Software Consortium](https://www.specifysoftware.org/membership-levels/) | ||
A great deal of user-facing documentation is available at our | ||
[Discourse forum](https://discourse.specifysoftware.org/). Most of it is | ||
available to users from member institutions only, thus | ||
[consider joining the Specify Software Consortium](https://www.specifysoftware.org/membership-levels/) | ||
if you are interested in becoming a power user of Specify 7. | ||
|
||
Besides the README.md files in most folders in this repository, there is also | ||
some developer facing documentation in | ||
our [GitHub Wiki](https://github.com/specify/specify7/wiki). | ||
|
||
If you are stuck and need help, consider emailing our support | ||
at [[email protected]](mailto:[email protected]), | ||
opening a [GitHub issue](https://github.com/specify/specify7/issues/new/choose) | ||
or posting a question on | ||
our [Discourse forum](https://discourse.specifysoftware.org/) | ||
as appropriate. | ||
some developer facing documentation in our | ||
[GitHub Wiki](https://github.com/specify/specify7/wiki). | ||
|
||
If you are stuck and need help, consider emailing our support at | ||
[[email protected]](mailto:[email protected]), opening a | ||
[GitHub issue](https://github.com/specify/specify7/issues/new/choose) or posting | ||
a question on our [Discourse forum](https://discourse.specifysoftware.org/) as | ||
appropriate. | ||
|
||
| Contact Option | Link | | ||
| --------------- | --------------------------------------------------------------------- | | ||
|
Oops, something went wrong.