Contributing guide #138
Contributing guide #138
Conversation
docs/src/main/tut/contributing.md
Outdated
| } | ||
| ``` | ||
|
|
||
| ## Wrapper |
There was a problem hiding this comment.
I don't know what happened but the Wrapper section is offset almost centered.
BenFradet
force-pushed
the
bf-contributing
branch
from
8814024
to
b629b31
Compare
Codecov Report
@@ Coverage Diff @@
## master #138 +/- ##
==========================================
+ Coverage 88% 88.17% +0.17%
==========================================
Files 36 36
Lines 550 558 +8
Branches 2 2
==========================================
+ Hits 484 492 +8
Misses 66 66
Continue to review full report at Codecov.
|
docs/src/main/tut/contributing.md
Outdated
| @@ -0,0 +1,386 @@ | |||
| --- | |||
| layout: docs | |||
There was a problem hiding this comment.
I'm wondering if it makes sense to put this awesome contributing guide in the microsite main page, using page layout. We did it in cats in this way: http://typelevel.org/cats/contributing.html
What do you think?
There was a problem hiding this comment.
Good idea, that way we avoid cluttering the documentation too much.
There was a problem hiding this comment.
Should we move it to a CONTRIBUTING.md at the root of the repo as in cats?
There was a problem hiding this comment.
We could, however, it's not mandatory. If we want to move it to the root I'm fine with that. Nevertheless, I'd separate it from the current CONTRIBUTING.md file in the root. What do you think about DEV_GUIDE.md or something similar? (afterward, when it's copied to the microsite territory we can rename it on the fly).
There was a problem hiding this comment.
I'm fine with leaving it where it is for now.
| ```bash | ||
| export GITHUB4S_ACCESS_TOKEN=aaaa | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I'd add a link indicating how generate this personal access token
| ## Integration tests | ||
|
|
||
| The integration tests are grouped by API in [github4s.integration package][integ-pkg]. As a result, | ||
| we'll be writing our tests in [GHReposSpec][repos-integ-spec-scala]: |
There was a problem hiding this comment.
Let's add that we only want integration tests for read-only operations
There was a problem hiding this comment.
the funny thing is that I was planning on adding it but completely forgot about it 😄
BenFradet
force-pushed
the
bf-contributing
branch
2 times, most recently
from
6c27c40
to
7d4962c
Compare
BenFradet
force-pushed
the
bf-contributing
branch
from
7d4962c
to
43004ba
Compare
No description provided.