diff --git a/development-workflow.md b/development-workflow.md index f7adaf1..07bb060 100644 --- a/development-workflow.md +++ b/development-workflow.md @@ -14,24 +14,29 @@ # Tests -* before pushing any code, make sure the tests still complete sucessfully -* to run them in Android Studio - * right-click on the briar-tests folder and select 'run all tests' to create a run configuration - * go to run > edit configurations to change the vm options for the 'all in briar-tests' configuration - * add `-Djava.library.path=../briar-desktop/libs` to the run configuration's vm options -* to run tests on the command line, do `gradle test` +* Before merging a branch, make sure the tests still pass +* To run the tests in Android Studio: + * Select 'Run > Edit Configurations' from the menu + * Click '+' and select 'JUnit' + * Set 'Test kind' to 'All in package' + * Set 'Search for tests' to 'Across module dependencies' + * Set 'VM options' to '-Djava.library.path=../briar-desktop/libs' + * Set 'Use classpath of module' to 'briar-android-tests' + * Click 'OK' to create the run configuration +* To run the tests from the command line: + * `./gradlew test --continue` # Issues * When you start working on a ticket, assign it to yourself * Label your ticket '[in progress](https://code.briarproject.org/akwizgran/briar/issues?state=opened&label_name=In+progress)' while you're working on it, then '[in code review](https://code.briarproject.org/akwizgran/briar/issues?state=opened&label_name=In+code+review)' while it's being reviewed -* When your branch is merged, label the ticket 'fixed' and close it or alternatively include 'Closes #55' in your commit message to close the ticket automatically. +* When your branch is merged, label the ticket 'fixed' and close it, or include 'Closes #55' in your commit message to close the ticket automatically (you still need to update the label) * As a rule of thumb, if a ticket takes longer than a day, break it into smaller tickets (mention the parent in the description) * Every ticket should be labelled 'bug', 'feature', 'feature request', 'task' or 'document' * Bugs are mistakes that affect the user, e.g. potential crashes * Features are work items that directly affect the user - * Feature requests are features that someone has asked for -- we might or might not implement them, but they're worth documenting + * Feature requests are features that someone has asked for -- we might or might not implement them, but either way they're worth documenting * Tasks are work items that don't directly affect the user, e.g. refactoring or research * Documents are work items that produce text rather than software @@ -39,10 +44,10 @@ * At the start of each week, let the team know what days you'll be working via the standup channel * Post a daily update to the standup channel saying: - * What you worked on yesterday/today? - * What you'll be working on today/tomorrow? - * Any blockers? -* If you're online at 10am UTC, please post your update at that time so we can have a standup meeting + * What you worked on yesterday/today + * What you'll be working on today/tomorrow + * Any blockers +* If you're awake and online at 10am UTC, please post your update at that time so we can have a standup meeting # Dependencies