mgdelacroix/campaigner
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update the README with the current flow status

Browse source
This commit is contained in:
Miguel de la Cruz 2020-02-29 14:38:32 +01:00
parent ecc5726804
commit deff8c4738
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -27,13 +27,14 @@ Use "campaigner [command] --help" for more information about a command.
## Application flow ## Application flow
1. Run `campaigner set-token` to set the tokens for `jira/github`. 1. Run `campaigner set-token` to set the tokens for `jira/github`.
2. Run `campaigner create` to create a new community campaign. 2. Run `campaigner init` to create a new community campaign.
3. Run `campaigner add` to add new tickets based either on a `grep/ag` 3. Run `campaigner add` to add new tickets based either on a `grep/ag`
command or a `govet` check. command or a `govet` check.
4. Run `campaigner state` to see the status of each one of the 4. Run `campaigner filter` to interactively remove false matches.
5. Run `campaigner status` to see the status of each one of the
tickets. The tickets can be in an `unpublished`, `jira`, `github` tickets. The tickets can be in an `unpublished`, `jira`, `github`
and `completed` state. and `completed` state.
5. Run `campaigner template` to edit the ticket template. 6. Modify the `template.md` file to adjust the ticket templates.
6. Run `campaigner publish` to create the tickets in `jira` based on 7. Run `campaigner publish` to create the tickets in `jira` based on
the template. the template.
7. Possible next step to publish the tickets from `jira` to `github`. 8. Possible next step to publish the tickets from `jira` to `github`.