Improve contributing #509
Merged
Improve contributing #509
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chicoxyzzy
reviewed
Jul 28, 2023
bcomnes
reviewed
Jul 28, 2023
CONTRIBUTING.md
Outdated
| @@ -1,55 +1,43 @@ | |||
| ## Contribution Guide Overview | |||
| This guide provides steps on how to make contributions and become a part of the ongoing development of `Socket Runtime`. | |||
| This guide provides steps on how to make contributions, report bugs, and become a part of the ongoing development of `Socket Runtime`. | |||
| If you are just started learning about Socket Runtime, you can start from [here](https://socketsupply.co/guides/). | |||
There was a problem hiding this comment.
Suggested change
| If you are just started learning about Socket Runtime, you can start from [here](https://socketsupply.co/guides/). | |
| If you are new to Socket Runtime, the [guide](https://socketsupply.co/guides/) is a good place start. |
bcomnes
reviewed
Jul 28, 2023
CONTRIBUTING.md
Outdated
|
|
||
| ### Requirements | ||
| ## Setup and build the framework |
There was a problem hiding this comment.
Suggested change
| ## Setup and build the framework | |
| ## Requirements |
Changing the header order is fine, but I think "Requirements" is more idiomatic.
bcomnes
reviewed
Jul 28, 2023
CONTRIBUTING.md
Outdated
|
|
||
| To contribute to the project you need to clone the repository and install the dependencies. You can do this by running the following commands: | ||
| To contribute to the project you need to clone the main repository first and install the dependencies. |
There was a problem hiding this comment.
Suggested change
| To contribute to the project you need to clone the main repository first and install the dependencies. | |
| To contribute to the project you need to clone the repository and install the dependencies. |
"main" and "first" read redundant.
|
I will apply the changes, thank you |
bcomnes
approved these changes
Jul 29, 2023
jwerle
approved these changes
Aug 9, 2023
jwerle
pushed a commit
that referenced
this pull request
Aug 22, 2023
* update-Contribution-wip * add deps * edit intro+dd link to docs * update paths * correct typo * add content/improve `contributing`-wip * add content/improve `contributing`-wip * add content/improve `contributing`-wip * add repos * few changes-Fix(links+spaces) * add more details * wip * add section about owning an issue * add link to all the repos * correct typos * correct error(bash) * apply brets suggestions * add report-security-issue * add link to report the issue
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.