Give the contributing guide a substantial rework #1155
Merged
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.
This changes the entire flow of the contributing guide. Please consider this a first draft (it still needs more details).
I tried to put the guide into a logical order for completing and understanding how to best start to contribute to Syft. I would value any feedback on the structure and if the current order makes sense.
The setup instructions are only for Debian at the moment. I will include at least OSX at some point in the near future (it takes a lot longer than one would expect to setup a clean machine).
Signed-off-by: Josh Bressers josh@bress.net