Friendlier contributing guide #439
Merged
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
…th getting up and running.
Codecov Report
@@ Coverage Diff @@
## main #439 +/- ##
=======================================
Coverage 81.58% 81.58%
=======================================
Files 26 26
Lines 2177 2177
=======================================
Hits 1776 1776
Misses 308 308
Partials 93 93 Continue to review full report at Codecov.
|
Co-authored-by: Aurélien Reeves <aurelien.reeves@smartbear.com>
Co-authored-by: Aurélien Reeves <aurelien.reeves@smartbear.com>
vearutop
reviewed
Nov 14, 2021
vearutop
reviewed
Nov 14, 2021
vearutop
approved these changes
Nov 14, 2021
Co-authored-by: Viacheslav Poturaev <vearutop@gmail.com>
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.
A baby step towards #406.
Having paired with a new contributor on godog this week, I noticed how we don't really document how to hack on godog.
I also noticed how unwelcoming the CONTRIBUTING.md file was.
I've changed the tone to be warmer and more welcoming, and I've also made an attempt to explain what people need to do if they want to start hacking on godog.
It would be amazing to have some input here from others who have more familiarity with this codebase. For example, I noticed there's a
Makefilewith amake testtarget, but to run that I need to install golint which is deprecated. Should we still advise people to install that too, and use themake testtarget?Update I figured out how to install
golintso I've changed the instructions to model that.