Skip to content

Commit a038a0f

Browse files
committed
[DOCS] update README.md
1 parent f66d7c5 commit a038a0f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,20 +248,31 @@ We welcome contributions from the community! FastAPI-fastkit is designed to help
248248
If you want to contribute to this project, we've made it easy to get started:
249249

250250
1. **Quick Development Setup:**
251+
252+
fork or clone this repository:
253+
251254
```bash
252255
git clone https://github.com/bnbong/FastAPI-fastkit.git
253256
cd FastAPI-fastkit
254257
make dev-setup
255258
```
256259

257260
2. **Available Development Commands:**
261+
262+
This project uses [Makefile](https://www.gnu.org/software/make/) to manage the development process.
263+
264+
You can use the following commands to help you get started:
265+
258266
```bash
259267
make help # See all available commands
260268
make dev-check # Run all checks before submitting
261269
make quick-test # Quick test after changes
262270
```
263271

264272
3. **Read our contribution guidelines:**
273+
274+
For other contribution guidelines, please refer to the following files:
275+
265276
- [CONTRIBUTING.md](CONTRIBUTING.md) - Detailed contribution guide
266277
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Project principles
267278
- [SECURITY.md](SECURITY.md) - Security guidelines

0 commit comments

Comments
 (0)