vechain / thor

A general purpose blockchain highly compatible with Ethereum's ecosystem
GNU Lesser General Public License v3.0
795 stars 248 forks source link

chore: update contributing docs #699

Closed darrenvechain closed 3 months ago

darrenvechain commented 3 months ago

Description

Update contributing guidelines

How Has This Been Tested?

git commit

Checklist:

libotony commented 3 months ago

A general question on the file, since it's a md file, do we need to manage the line length ourselves?

darrenvechain commented 3 months ago

A general question on the file, since it's a md file, do we need to manage the line length ourselves?

How do you mean by manage the line length?

libotony commented 3 months ago

A general question on the file, since it's a md file, do we need to manage the line length ourselves?

How do you mean by manage the line length?

In the code, the line has human-made line breaks. For example:

1 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
2   GitHub documentation
darrenvechain commented 3 months ago

A general question on the file, since it's a md file, do we need to manage the line length ourselves?

How do you mean by manage the line length?

In the code, the line has human-made line breaks. For example:

1 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
2   GitHub documentation

Ah yes, this is auto formatting from JetBrains. I can manually remove these if it's preferred?

libotony commented 3 months ago

A general question on the file, since it's a md file, do we need to manage the line length ourselves?

How do you mean by manage the line length?

In the code, the line has human-made line breaks. For example:

1 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
2   GitHub documentation

Ah yes, this is auto formatting from JetBrains. I can manually remove these if it's preferred?

Can you do another format on top of this PR? I have noticed it via

1    - **Note:**: Please refer to the [README](https://github.com/vechain/thor/blob/master/README.md) for information on
2      how to start the node and interact with the
3      API
darrenvechain commented 3 months ago

A general question on the file, since it's a md file, do we need to manage the line length ourselves?

How do you mean by manage the line length?

In the code, the line has human-made line breaks. For example:

1 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
2   GitHub documentation

Ah yes, this is auto formatting from JetBrains. I can manually remove these if it's preferred?

Can you do another format on top of this PR? I have noticed it via

1    - **Note:**: Please refer to the [README](https://github.com/vechain/thor/blob/master/README.md) for information on
2      how to start the node and interact with the
3      API

Yepp, I fixed formatting and pushed it latest commit