You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you are working in VSCode, we recommend you install the [rust-analyzer](https://rust-analyzer.github.io/) extension, and use the following VSCode user settings:
@@ -103,7 +110,7 @@ If you are working on a larger feature, we encourage you to open up a draft pull
103
110
104
111
If you would like to test the binaries built from your change, see [foundryup](https://github.com/foundry-rs/foundry/tree/master/foundryup).
105
112
106
-
If you would like to use a debugger with breakpoints to debug a patch you might be working on, keep in mind we currently strip debug info for faster builds, which is *not* the default. Therefore, to use a debugger, you need to enable it on the workspace [`Cargo.toml`'s `dev` profile](https://github.com/foundry-rs/foundry/tree/master/Cargo.toml#L15-L18).
113
+
If you would like to use a debugger with breakpoints to debug a patch you might be working on, keep in mind we currently strip debug info for faster builds, which is _not_ the default. Therefore, to use a debugger, you need to enable it on the workspace [`Cargo.toml`'s `dev` profile](https://github.com/foundry-rs/foundry/tree/master/Cargo.toml#L15-L18).
107
114
108
115
#### Adding tests
109
116
@@ -113,9 +120,9 @@ in the future.
113
120
114
121
Types of tests include:
115
122
116
-
-**Unit tests**: Functions which have very specific tasks should be unit tested.
117
-
-**Integration tests**: For general purpose, far reaching functionality, integration tests should be added.
118
-
The best way to add a new integration test is to look at existing ones and follow the style.
123
+
-**Unit tests**: Functions which have very specific tasks should be unit tested.
124
+
-**Integration tests**: For general purpose, far reaching functionality, integration tests should be added.
125
+
The best way to add a new integration test is to look at existing ones and follow the style.
119
126
120
127
Tests that use forking must contain "fork" in their name.
echo"codespell not found. Please install it by running the command `pip install codespell` or refer to the following link for more information: https://github.com/codespell-project/codespell"\
104
+
lint-codespell:## Run codespell on the codebase.
105
+
@command -v codespell >/dev/null|| { \
106
+
echo"codespell not found. Please install it by running the command `pipx install codespell` or refer to the following link for more information: https://github.com/codespell-project/codespell"\
97
107
exit 1;\
98
-
fi
108
+
}
109
+
codespell --skip "*.json"
99
110
100
111
lint: ## Run all linters.
101
112
make fmt &&\
102
-
make lint-foundry&&\
113
+
make lint-clippy&&\
103
114
make lint-codespell
104
115
105
-
## Testing
106
-
107
-
test-foundry:
108
-
cargo nextest run -E 'kind(test) & !test(/\b(issue|ext_integration)/)'
109
-
110
-
test-doc:
111
-
cargo test --doc --workspace
116
+
##@ Other
112
117
113
-
test: ## Run all tests.
114
-
make test-foundry &&\
115
-
make test-doc
118
+
.PHONY: clean
119
+
clean: ## Clean the project.
120
+
cargo clean
116
121
117
122
pr: ## Run all tests and linters in preparation for a PR.
0 commit comments