Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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 .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ jobs:
run: |
forge --version

# - name: Run Forge fmt
# run: |
# forge fmt --check
# id: fmt
- name: Run Forge fmt
run: |
forge fmt --check
id: fmt

- name: Run Forge build
run: |
Expand Down
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,34 @@ The design and implementation of Compose is based on the following design princi

## Contributors

New contributors are welcome. Choose the [issues](https://github.com/Perfect-Abstractions/Compose/issues) you want to work on and leave comments describing what you want to do and how you want to do it. I'll answer you and assign you to issues and you can start.
New contributors are welcome!

Choose the [issues](https://github.com/Perfect-Abstractions/Compose/issues) you want to work on and leave comments describing what you want to do and how you want to do it. I'll answer you and assign you to issues and you can start.

Look at the [ERC20 and ERC721 implementations](./src/) to see examples of how things are written in this library.

Once you are assigned to an issue you can fork the repository, implement what you are working on, then submit a pull request and I will review it and merge it and/or give you feedback on the work.

You can also make new issues to suggest new functionality or work.

### Code Formatting Requirements

All pull requests must pass the Forge formatting check before they can be merged. The CI pipeline automatically runs `forge fmt --check` to verify that your code follows the project's formatting standards.

**Before submitting your PR:**

1. Run the formatter locally to auto-fix any formatting issues:
```shell
$ forge fmt
```

2. Verify that your code passes the formatting check:
```shell
$ forge fmt --check
```

If your PR fails the formatting check in CI, it will need to be updated before it can be reviewed and merged. This ensures consistent code style across the entire codebase and aligns with our principle that "code is written to be read."

If you have contribution or development questions then please contact me or create an issue. The discord for Compose is here: https://discord.gg/DCBD2UKbxc

This is the beginning and we are still working out how this will all work. I am glad you are interested in this project and I want to make something great with you.
Expand Down