mirror of
https://github.com/evroon/bracket.git
synced 2026-07-31 02:10:50 -04:00
3606868b98
This PR migrates formatting in `frontend/` from Prettier to `oxfmt`,
including script wiring and dependency cleanup. It removes the Prettier
plugin/config path so formatting is handled by a single tool.
- **Script migration**
- Renamed/rewired formatting scripts in `frontend/package.json`:
- `prettier:check` → `format:check` (`oxfmt --check .`)
- `prettier:write` → `format:write` (`oxfmt .`)
- Updated dependent scripts:
- `test` now runs `pnpm run format:write`
- `openapi-ts` now runs `pnpm run format:write` after generation
- **Dependency cleanup**
- Removed `prettier-plugin-organize-imports` from `dependencies`
- Removed `prettier` from `devDependencies`
- Added `oxfmt` (latest stable at update time)
- **Config removal**
- Deleted `frontend/.prettierrc.js` (no longer used after migration)
- **Lockfile alignment**
- Updated `frontend/pnpm-lock.yaml` to reflect the dependency and script
ecosystem change
```json
{
"scripts": {
"format:check": "oxfmt --check .",
"format:write": "oxfmt .",
"openapi-ts": "openapi-ts && pnpm run format:write",
"test": "tsc && pnpm run format:write"
}
}
```
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Erik Vroon <11857441+evroon@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
80 lines
2.7 KiB
Plaintext
80 lines
2.7 KiB
Plaintext
---
|
|
title: Contributing
|
|
---
|
|
|
|
import { Callout } from "nextra/components";
|
|
|
|
# Contributing
|
|
|
|
If you're using Bracket and would like to help support its development, that would be greatly
|
|
appreciated!
|
|
|
|
Several areas that we need a bit of help with at the moment are:
|
|
|
|
- ⭐ **Star Bracket** on GitHub
|
|
- 🌐 **Translating**: Help make Bracket available to non-native English speakers by adding your
|
|
language. See [Translating](#translating) below.
|
|
- 📣 **Spread the word** by sharing Bracket to help new users discover it
|
|
- 🖥️ **Submit a PR** to add a new feature, fix a bug, extend/update the docs or something else
|
|
|
|
## Translating
|
|
|
|
### Adding translations (via crowdin)
|
|
|
|
Bracket uses [crowdin](https://crowdin.com/project/bracket) for translations. You can add/improve
|
|
translations here in your language.
|
|
|
|
If you want to add a new language, please create an issue and I will add the language to Crowdin.
|
|
|
|
### Manually adding translations
|
|
|
|
You can add a translation by copying the English
|
|
[`en` locale](https://github.com/evroon/bracket/tree/master/frontend/public/locales) directory.
|
|
Rename the directory to the name of your locale, and start translating the `common.json` file inside
|
|
the directory. It might be useful to use an online tool (Google `translate json file`) to do the
|
|
translation for you, and then carefully check and correct any mistakes.
|
|
|
|
## Code contributions
|
|
|
|
Code contributions are welcome! Please make sure to adhere to the following when submitting a pull
|
|
request:
|
|
|
|
- Limit Pull Request (PR) size: Aim for small PRs (around 300 lines) that focus on a single,
|
|
clear task. This makes them faster to review and more likely to be merged.
|
|
- Write clear, descriptive titles.
|
|
- Test your code changes thoroughly.
|
|
|
|
<Callout type="warning">
|
|
Before making a pull request of something that's not trivial, please open an issue to discuss it
|
|
first. Often there's a simpler way to achieve a certain goal or the scope of Bracket will be too
|
|
large to maintain if every type of feature gets added.
|
|
|
|
Smaller changes like small bug fixes or documentation improvements can be made without opening
|
|
an issue first.
|
|
|
|
</Callout>
|
|
|
|
## Contributors
|
|
|
|
See [README](https://github.com/evroon/bracket).
|
|
|
|
## Star History
|
|
|
|
<a href="https://star-history.com/#evroon/bracket&Date">
|
|
<picture>
|
|
<source
|
|
media="(prefers-color-scheme: dark)"
|
|
srcSet="https://api.star-history.com/svg?repos=evroon/bracket&type=Date&theme=dark"
|
|
/>
|
|
<source
|
|
media="(prefers-color-scheme: light)"
|
|
srcSet="https://api.star-history.com/svg?repos=evroon/bracket&type=Date"
|
|
/>
|
|
<img
|
|
alt="Star History Chart"
|
|
src="https://api.star-history.com/svg?repos=evroon/bracket&type=Date"
|
|
/>
|
|
</picture>
|
|
</a>
|
|
{/*<!-- markdownlint-enable line-length -->*/}
|