Skip to content
This repository has been archived by the owner on Apr 9, 2021. It is now read-only.

chore: update opendatakit to getodk #379

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Thank you for contributing to ODK!

#### Before submitting this PR, please make sure you have:
- [ ] run `./gradlew checkCode` and confirmed all checks still pass OR confirm CircleCI build passes
- [ ] verified that any code or assets from external sources are properly credited in comments and/or in the [about file](https://github.com/opendatakit/share/blob/master/share_app/src/main/assets/open_source_licenses.html).
- [ ] verified that any code or assets from external sources are properly credited in comments and/or in the [about file](https://github.com/getodk/share/blob/master/share_app/src/main/assets/open_source_licenses.html).
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ This is a living document. If you see something that could be improved, edit thi
## Submitting a pull request
To contribute code to Skunkworks-Crow, you will need to open a [pull request](https://help.github.com/articles/about-pull-requests/) which will be reviewed by the community and then merged into the core project. Generally, a pull request is submitted when a unit of work is considered complete but it can sometimes be helpful to share ideas through a work in progress (WIP) pull request ([learn more](#work-in-progress-pull-requests)).

1. [Set up your development environment](https://github.com/opendatakit/skunkworks-crow#setting-up-your-development-environment).
1. [Set up your development environment](https://github.com/getodk/skunkworks-crow#setting-up-your-development-environment).

1. To make sure you have the latest version of the code, set up this repository as [a remote for your fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and then [sync your fork](https://help.github.com/articles/syncing-a-fork/).

1. Create a branch for the code you will be writing:

git checkout -b NAME_OF_YOUR_BRANCH

1. If there is an [issue](https://github.com/opendatakit/skunkworks-crow/issues) corresponding to what you will work on, put `@opendatakit-bot claim` as a comment on issue to say you are claiming it. If this is your first time contributing to the repo, the bot will send you an invite. Once you accept this invite, the bot will assign you to the issue. If there is no issue yet, create one to provide background on the problem you are solving.
1. If there is an [issue](https://github.com/getodk/skunkworks-crow/issues) corresponding to what you will work on, put `@getodk-bot claim` as a comment on issue to say you are claiming it. If this is your first time contributing to the repo, the bot will send you an invite. Once you accept this invite, the bot will assign you to the issue. If there is no issue yet, create one to provide background on the problem you are solving.

1. Once you've made incremental progress towards you goal, commit your changes with a meaningful commit message. Use [keywords for closing issues](https://help.github.com/articles/closing-issues-via-commit-messages/) to refer to issues and have them automatically close when your changes are merged.

Expand All @@ -32,9 +32,9 @@ To contribute code to Skunkworks-Crow, you will need to open a [pull request](ht

git push

1. When your changes are ready to be added to the core Skunkworks-Crow project, [open a pull request](https://help.github.com/articles/creating-a-pull-request/). Make sure to set the base fork to `opendatakit/skunkworks-crow`. Describe your changes in the comment, refer to any relevant issues using [keywords for closing issues](https://help.github.com/articles/closing-issues-via-commit-messages/) and tag any person you think might need to know about the changes.
1. When your changes are ready to be added to the core Skunkworks-Crow project, [open a pull request](https://help.github.com/articles/creating-a-pull-request/). Make sure to set the base fork to `getodk/skunkworks-crow`. Describe your changes in the comment, refer to any relevant issues using [keywords for closing issues](https://help.github.com/articles/closing-issues-via-commit-messages/) and tag any person you think might need to know about the changes.

1. Pull requests will be reviewed when committers have time. If you haven't received a review in 10 days, you may notify committers by putting `@opendatakit/skunkworks-crow` in a comment.
1. Pull requests will be reviewed when committers have time. If you haven't received a review in 10 days, you may notify committers by putting `@getodk/skunkworks-crow` in a comment.

## Making sure your pull request is accepted
1. Confirm that your code compiles.
Expand Down Expand Up @@ -68,7 +68,7 @@ We try to have at least two people review every pull request and we encourage ev
- Is the code easy to understand and to maintain?
- Is there sufficient detail to inform any changes to documentation?

When a pull request is first created, @opendatakit-bot tags it as `needs review` to indicate that code review is needed. Community members review the code and leave their comments, verifying that the changes included are relevant and properly address the issue. A maintainer does a thorough code review and when satisfied with the code, tags the pull request as `needs testing` to indicate the need for a manual [black-box testing](https://en.wikipedia.org/wiki/Black-box_testing) pass. A pull request may go back and forth between `needs testing` and `needs review` until the behavior is thoroughly verified. Once the behavior has been thoroughly verified, the pull request is tagged as `behavior verified`. A maintainer then merges the changes. Pull requests that need more complete reviews including review of approach and/or appropriateness are tagged with `reviews wanted`. Any community member is encouraged to participate in the review process!
When a pull request is first created, @getodk-bot tags it as `needs review` to indicate that code review is needed. Community members review the code and leave their comments, verifying that the changes included are relevant and properly address the issue. A maintainer does a thorough code review and when satisfied with the code, tags the pull request as `needs testing` to indicate the need for a manual [black-box testing](https://en.wikipedia.org/wiki/Black-box_testing) pass. A pull request may go back and forth between `needs testing` and `needs review` until the behavior is thoroughly verified. Once the behavior has been thoroughly verified, the pull request is tagged as `behavior verified`. A maintainer then merges the changes. Pull requests that need more complete reviews including review of approach and/or appropriateness are tagged with `reviews wanted`. Any community member is encouraged to participate in the review process!

Small fixes that target very particular bugs may occasionally be merged without a second review.

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# skunkworks-crow
![Platform](https://img.shields.io/badge/platform-Android-blue.svg)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Build status](https://circleci.com/gh/opendatakit/skunkworks-crow.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/opendatakit/skunkworks-crow)
[![Slack status](http://slack.opendatakit.org/badge.svg)](http://slack.opendatakit.org)
[![Build status](https://circleci.com/gh/getodk/skunkworks-crow.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/getodk/skunkworks-crow)
[![Slack status](http://slack.getodk.org/badge.svg)](http://slack.getodk.org)

## Table of Contents
1. [Introduction](#introduction)
Expand Down Expand Up @@ -50,14 +50,14 @@ The skunkworks-crow app requires ODK Collect installed on the device first becau

### 2.1 Install and setting up ODK Collect<a name="install-collect"></a>

To install ODK Collect visit [this](https://docs.opendatakit.org/collect-install) link.
To know more about ODK Collect visit the [documentation](https://docs.opendatakit.org/collect-intro) page
To install ODK Collect visit [this](https://docs.getodk.org/collect-install) link.
To know more about ODK Collect visit the [documentation](https://docs.getodk.org/collect-intro) page

### 2.2 Install skunkworks-crow<a name="install-skunkworks-crow"></a>

skunkworks-crow app can be downloaded and installed from the link provided below.

[Download APK](https://github.com/opendatakit/skunkworks-crow/releases)
[Download APK](https://github.com/getodk/skunkworks-crow/releases)

## 3. Using skunkworks-crow<a name="using-skunkworks-crow"></a>
Skunkworks-crow app can be used by enumerators in sharing forms and by supervisor in reviewing the forms.
Expand Down Expand Up @@ -197,6 +197,6 @@ If you changed the method of sender/receiver, don't forget to be consistent with
## 6. Contributing code<a name="contributing-code"/>
Any and all contributions to the project are welcome. Skunkworks-Crow is used across the world primarily by organizations with a social purpose so you can have real impact!

Issues tagged as [good first issue](https://github.com/opendatakit/skunkworks-crow/labels/good%20first%20issue) should be a good place to start. There are also currently many issues tagged as [needs reproduction](https://github.com/opendatakit/skunkworks-crow/labels/needs%20reproduction) which need someone to try to reproduce them with the current version of Skunkwork-Crow and comment on the issue with their findings.
Issues tagged as [good first issue](https://github.com/getodk/skunkworks-crow/labels/good%20first%20issue) should be a good place to start. There are also currently many issues tagged as [needs reproduction](https://github.com/getodk/skunkworks-crow/labels/needs%20reproduction) which need someone to try to reproduce them with the current version of Skunkwork-Crow and comment on the issue with their findings.
If you're ready to contribute code, see [the contribution guide](CONTRIBUTING.md).