Skip to content

chore: update readme to reflect new linting #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2025
Merged

chore: update readme to reflect new linting #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ Account Kit documentation is maintained in the [aa-sdk repository](https://githu
4. Push to your fork
5. Create a pull request to the upstream

## Markdown Style Guide

This project implements a modified version of the [Markdown Style Guide](https://google.github.io/styleguide/docguide/style.html) which is enforced in Eslint via [remark-lint](https://github.com/remarkjs/remark-lint). Please ensure you abide by the guidelines set there.

## Keeping Your Fork Updated

To keep your fork up-to-date with the original repository:
Expand Down Expand Up @@ -79,10 +83,6 @@ git push origin main

Unsure how to make changes yourself? Feel free to open an issue using the appropriate template. Please fill out required fields and provide as much detail as possible to ensure contributors can be as helpful as possible.

## Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of differing viewpoints and experiences.

Comment on lines -82 to -85
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK we don't actually have a code of conduct. If we ask people to follow one we should make it first

## Questions?

If you have any questions or need help, please open an issue in the repository.
Expand Down
25 changes: 17 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The latest documentation lives on https://alchemy.docs.buildwithfern.com/home

## Project Structure

```md
```text
/
├── src/
│ ├── openapi/ # REST API definitions (OpenAPI)
Expand Down Expand Up @@ -60,7 +60,7 @@ This will generate all specs as dereferenced json files in the `build/` director

### Validation

You can validate both specs and MDX using scripts.
You can validate both OpenAPI and OpenRPC using scripts.

```bash
# Validate REST API specs
Expand All @@ -69,15 +69,24 @@ pnpm run validate:rest
# Validate RPC specs
pnpm run validate:rpc

# Validate markdown files
pnpm run validate:mdx
# Or you can run them together with
pnpm run validate
```

Or you can run them together using
### Linting

```bash
pnpm run validate
```
The project uses several linting tools to ensure code quality and consistency:

* **ESLint**: For JavaScript and TypeScript code linting
* **Prettier**: For code formatting
* **Remark**: For Markdown/MDX linting
* **TypeScript**: For type checking

You can find the appropriate commands for running each in `package.json`

#### Enforcement

The project uses [Husky](https://typicode.github.io/husky) and [lint-staged](https://github.com/lint-staged/lint-staged) to run linting checks before commits.

## Contributing

Expand Down