Skip to content

Commit

Permalink
chore: adding document link to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kehiy committed Aug 13, 2024
1 parent 27423a2 commit a59c097
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Please follow these guidelines when contributing to the project:
You can use these commands in the Makefile:

- `make build` compiles the code into executable binaries.
- `make build_gui` compiles the gtk GUI code into executable binary.
- `make devtools` installs required development tools.
- `make fmt` formats the code according to the Go standards.
- `make check` runs checks on the code, including formatting and linting.
Expand All @@ -27,6 +28,10 @@ You can use these commands in the Makefile:
- `make proto` generates [protobuf](https://protobuf.dev/) files.
Run this target if you have made any changes to the proto buffer files.

### GUI Development

Development of the Pactus Core GUI have some requirements on your machine which you can find a [quick guide about it here](./docs/gtk-gui-development.md).

### Error and Log Messages

Error and log messages should not start with a capital letter (unless it's a proper noun or acronym) and
Expand Down Expand Up @@ -115,4 +120,4 @@ Please read it before contributing to the project.

---

Thank you for your contributions to Pactus blockchain!
Thank you for your contributions to the Pactus blockchain!

0 comments on commit a59c097

Please sign in to comment.