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.

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

Update contributing guide with Knit #2634

Merged
merged 2 commits into from Jan 13, 2022

Conversation

lukaszkalnik
Copy link
Contributor

Some small updates to the contributing guide:

  • Mention in code snippets policy that code snippets have to be annotated with Knit
  • Update code snippet link and example (the link pointed to an old snippet using ank)
  • Define more precisely that the apiDump task can be called only for changed subproject (no need to run it for the whole project when only suproject has changed).

Copy link
Member

@nomisRev nomisRev left a comment

Choose a reason for hiding this comment

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

Thanks for the great additions @lukaszkalnik 🙏

@nomisRev nomisRev requested a review from a team January 12, 2022 09:30
CONTRIBUTING.md Outdated
Comment on lines 247 to 253
./gradlew apiDump
./gradlew :arrow-core:apiDump

Choose a reason for hiding this comment

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

Is it not easier to just run apiDump in all projects?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe you're right... I just tested on a project without API changes.
The initial run of ./gradlew apiDump took 2 min 13 s on my MacBook.
All the subsequent runs take around 50-55 s, regardless if I run the task on all projects with ./gradlew apiDump or just one subproject with ./gradlew :arrow-core-retrofit:apiDump. This is because Gradle recognizes the task as up-to-date:

> Task :arrow-core-retrofit:compileKotlin UP-TO-DATE
> Task :arrow-core-retrofit:compileJava NO-SOURCE
> Task :arrow-core-retrofit:classes UP-TO-DATE
> Task :arrow-core-retrofit:apiBuild UP-TO-DATE
> Task :arrow-core-retrofit:apiDump UP-TO-DATE

So it's probably better to remove this remark 👍

Copy link
Member

@JavierSegoviaCordoba JavierSegoviaCordoba left a comment

Choose a reason for hiding this comment

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

Thanks :)

@nomisRev nomisRev merged commit 9a9ecf8 into arrow-kt:main Jan 13, 2022
@lukaszkalnik lukaszkalnik deleted the update-contributing-guide-2 branch January 21, 2022 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants