Skip to content

Commit

Permalink
changelog and dev readme
Browse files Browse the repository at this point in the history
  • Loading branch information
45930 committed Feb 6, 2025
1 parent c7dd694 commit ad1a0fe
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
- Doc comments for various ZkProgram methods https://github.com/o1-labs/o1js/pull/1974
- `MerkleList.popOption()` for popping the last element and also learning if there was one https://github.com/o1-labs/o1js/pull/1997
- Added custom header support for `Fetch` methods such as `fetchEvents`, `fetchActions` etc. and to `Mina` instance. Also added two new methods `setMinaDefaultHeaders` and `setArchiveDefaultHeaders` https://github.com/o1-labs/o1js/pull/2004
- Added style rules for contributors https://github.com/o1-labs/o1js/pull/2012

### Changed

Expand Down
17 changes: 17 additions & 0 deletions README-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,23 @@ Where:

- `develop`: This branch is maintained across all three repositories. It is used for ongoing (next hard-fork) development, testing new features and integration work.

### Style Guide

This repo uses minimal [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and [prettier](https://prettier.io/docs/) configs to stay tidy. Here are some tips to comply with the style:

1. Check for style violations by running the npm commands `npm run lint path/to/file` and `npm run format:check path/to/file`
- To attempt to fix all style violations in all changed filed, you can run:
- `git diff --cached --name-only --diff-filter=d | grep -E '\.(ts|js)$' | xargs npm run format`
- and `git diff --cached --name-only --diff-filter=d | grep -E '\.(ts|js)$' | xargs npm run lint:fix`
2. Integrate prettier into your dev environment
- For instance the [VS Code](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin allows for format on save
3. Enable pre-commit hooks
- There is an opt-in pre-commit hook avaibale that will attempt to fix styling for all diffed files. Enable it by running `git config husky.optin true`

> [!NOTE]
> You can opt-out of linting in a PR by tagging it with skip-lint, in case the linting script is legitimately blocking an important PR

### Running Tests

To ensure your changes don't break existing functionality, run the test suite:
Expand Down

0 comments on commit ad1a0fe

Please sign in to comment.