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
Thanks for your interest in contributing to aDI Deploy! Please take a moment to review this document **before submitting a pull request.**
4
+
5
+
## Rules
6
+
7
+
1. Significant changes to the Protocol must be reviewed before a Pull Request is created. Create a [Feature Request](https://github.com/aave-dao/adi-deploy/issues) first to discuss your ideas.
8
+
2. Contributors must be humans, not bots.
9
+
3. First time contributions must not contain only spelling or grammatical fixes.
10
+
11
+
## Basic guide
12
+
13
+
This guide is intended to help you get started with contributing. By following these steps, you will understand the development process and workflow.
14
+
15
+
1. [Forking the repository](#forking-the-repository)
adi Deploy is a [Foundry](https://github.com/foundry-rs/foundry) project.
48
+
49
+
Install foundry using the following command:
50
+
51
+
```bash
52
+
curl -L https://foundry.paradigm.xyz | bash
53
+
```
54
+
55
+
---
56
+
57
+
### Installing dependencies
58
+
59
+
For generating the changelog, linting and testing, we rely on some additional node packages. You can install them byrunning:
60
+
61
+
```bash
62
+
npm install
63
+
```
64
+
65
+
---
66
+
67
+
### Running the test suite
68
+
69
+
For running the default test suite you can use the following command:
70
+
71
+
```bash
72
+
forge test
73
+
```
74
+
75
+
---
76
+
77
+
### Submitting a pull request
78
+
79
+
When you're ready to submit a pull request, you can follow these naming conventions:
80
+
81
+
- Pull request titles use the [Imperative Mood](https://en.wikipedia.org/wiki/Imperative_mood) (e.g., `Add something`, `Fix something`).
82
+
- [Changesets](#versioning) use past tense verbs (e.g., `Added something`, `Fixed something`).
83
+
84
+
When you submit a pull request, GitHub will automatically lint, build, and test your changes. If you see an ❌, it's most likely a bug in your code. Please, inspect the logs through the GitHub UI to find the cause.
85
+
86
+
- Pull requests must always cover all the changes made with tests. If you're adding a new feature, you must also add a test for it. If you're fixing a bug, you must add a test that reproduces the bug. Pull requests that cause a regression in test coverage will not be accepted.
87
+
- Pull requests that touch code functionality should always include updated gas snapshots. Running `forge test` will update the snapshots for you.
88
+
- Make sure that your updates are fitting within the existing code margin. You can check by running `forge build --sizes`
0 commit comments