Skip to content

Commit

Permalink
chore: update contributing docs (#699)
Browse files Browse the repository at this point in the history
* chore: update contributing docs

* chore: run md formatter
  • Loading branch information
darrenvechain committed Apr 16, 2024
1 parent d779d01 commit f9e6ba4
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
15 changes: 10 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,12 @@ current development landscape.
```bash
make test
```
- **Note:**: Please refer to the [README](https://github.com/vechain/thor/blob/master/README.md) for information on how to start the node and interact with the
API.
- **Note:**: Please refer to the [README](https://github.com/vechain/thor/blob/master/README.md) for information on
how to start the node and interact with the API.
5. Make your changes and commit them with a clear and concise commit message.
6. Push your changes to your forked repository:
6. Push your changes to your forked repository. **Note:** All commits must be signed with a GPG key. If you haven't
already set up a GPG key, please refer to the GitHub documentation
on [Signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account).
```bash
git push origin feature/your-feature-name
```
Expand All @@ -60,5 +62,8 @@ current development landscape.
### Code Linting
- We employ `golangci-lint` for code linting in our development process. It ensures that code adheres to established standards, and any changes that do not pass the linting checks will trigger an error during the Continuous Integration (CI) process.
- You can run it locally by installing the `golangci-lint` binary and running `make lint` in the root directory of the repository.
- We employ `golangci-lint` for code linting in our development process. It ensures that code adheres to established
standards, and any changes that do not pass the linting checks will trigger an error during the Continuous
Integration (CI) process.
- You can run it locally by installing the `golangci-lint` binary and running `make lint` in the root directory of the
repository.
7 changes: 5 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List
any dependencies that are required for this change.

Fixes # (issue)

Expand All @@ -15,12 +16,14 @@ Please delete options that are not relevant.

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also
list any relevant details for your test configuration

- [x] Test A
- [x] Test B

**Test Configuration**:

* Go Version:
* Hardware:
* Docker Version:
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,4 @@ A special shout out to following projects:

## License

Vechain Thor is licensed under the
[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.html), also included
in *LICENSE* file in repository.
Vechain Thor is licensed under the [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.html), also included in *LICENSE* file in repository.

0 comments on commit f9e6ba4

Please sign in to comment.