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

[#66] Prepare for 1.0.3 release #67

Merged
merged 4 commits into from
Jun 14, 2022
Merged

[#66] Prepare for 1.0.3 release #67

merged 4 commits into from
Jun 14, 2022

Conversation

ccjernigan
Copy link
Contributor

@ccjernigan ccjernigan commented Jun 13, 2022

This code review checklist is intended to serve as a starting point for the author and reviewer, although it may not be appropriate for all types of changes (e.g. fixing a spelling typo in documentation). For more in-depth discussion of how we think about code review, please see Code Review Guidelines.

Author

  • Self-review: Did you review your own code in GitHub's web interface? Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.
  • Automated tests: Did you add appropriate automated tests for any code changes?
  • Code coverage: Did you check the code coverage report for the automated tests? _While we are not looking for perfect coverage, the tool can point out potential cases that have been missed. Run ./gradlew check then coverage reports are generated under build/reports/kover.
  • Documentation: Did you update documentation as appropriate? (e.g README.md, etc.)
  • Rebase and squash: Did you pull in the latest changes from the main branch and squash your commits before assigning a reviewer? Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit.

Reviewer

  • Checklist review: Did you go through the code with the Code Review Guidelines checklist?
  • Ad hoc review: Did you perform an ad hoc review? In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass.
  • Automated tests: Did you review the automated tests?
  • Manual tests: Did you review the manual tests?
  • How is code coverage affected by this PR? We encourage you to compare coverage before and after changes and when possible, leaving it in a better place.
  • Documentation: Did you review Docs and README.md as appropriate?

@ccjernigan ccjernigan requested a review from HonzaR June 13, 2022 18:18
Copy link
Collaborator

@HonzaR HonzaR left a comment

Choose a reason for hiding this comment

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

I've added some minor changes to links in PUBLISHING.md and removed mentioned MIGRATIONS.md, as we do not have it here in the repository. I've also left 2 comments in PUBLISHING.md. Other than that, it looks alright.

docs/PUBLISHING.md Outdated Show resolved Hide resolved
See [ci.md](ci.md), which describes the continuous integration workflow for deployment and describes the secrets that would need to be configured in a repository fork.

## One time only
* Set up environment to [compile the SDK](https://github.com/zcash/zcash-android-wallet-sdk/#compiling-sources)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This link leads to the SDK project, as we do not have this part of the documentation in this repository, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed that link and filed #70 to add better setup documentation for this project.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ok, sounds good.

@ccjernigan ccjernigan linked an issue Jun 14, 2022 that may be closed by this pull request
@ccjernigan ccjernigan merged commit 1108fe1 into main Jun 14, 2022
@ccjernigan ccjernigan deleted the 66-prepare-next-release branch June 14, 2022 11:47
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.

Prepare for 1.0.3 release
2 participants