Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add contributing guidelines with how to build docs #1065

Merged
merged 7 commits into from
Oct 28, 2018
Merged

Add contributing guidelines with how to build docs #1065

merged 7 commits into from
Oct 28, 2018

Conversation

iboss-ptk
Copy link
Contributor

@codecov
Copy link

codecov bot commented Oct 24, 2018 •
edited
Loading

Codecov Report

Merging #1065 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##             master   #1065      +/-   ##
===========================================
- Coverage     42.61%   42.6%   -0.02%     
  Complexity      746     746              
===========================================
  Files           359     359              
  Lines          9867    9867              
  Branches       1078    1078              
===========================================
- Hits           4205    4204       -1     
  Misses         5347    5347              
- Partials        315     316       +1
Impacted Files Coverage Δ Complexity Δ
...ics/src/main/kotlin/arrow/optics/instances/mapk.kt 86.36% <0%> (-4.55%) 0% <0%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 15a1d7a...0fcfb77. Read the comment docs.

pakoito
pakoito reviewed Oct 24, 2018
View reviewed changes
CONTRIBUTING.md
* Adding a new datatype
* Adding a new typeclass
* Running tests
* [Building documentation](#building-documentation)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I like this.

pakoito
pakoito reviewed Oct 24, 2018
View reviewed changes
CONTRIBUTING.md Outdated
Documentation is being built by [ΛNK](https://github.com/arrow-kt/ank) which gives an ability to verify and interpret code snippets in the documentation. For example:


```kotlin:ank
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra spaces here

pakoito
pakoito reviewed Oct 24, 2018
View reviewed changes
CONTRIBUTING.md Outdated
To build the documentation, in the root of the project, run

```
$ ./gradlew clean :arrow-docs:clean :arrow-docs:runAnk
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clean implies arrow-docs:clean AFAIK.

pakoito
pakoito approved these changes Oct 24, 2018
View reviewed changes
Copy link
Member

@pakoito pakoito left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice first contribution, many thanks! This'll be useful :D Could you please fix the couple of tweaks I suggested before we merge?

@pakoito pakoito merged commit 61202e5 into arrow-kt:master Oct 28, 2018
@pakoito
Copy link
Member

pakoito commented Oct 28, 2018

@iboss-ptk I added the changes myself, so we could get it merge today :D Thanks for the first contribution!

@raulraja raulraja mentioned this pull request Nov 2, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pakoito pakoito pakoito approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@iboss-ptk @pakoito @calvellido