Create a README #8
Conversation
README.md
Outdated
| # issue-sync | ||
| A tool for synchronizing issues between GitHub and JIRA | ||
|
|
||
| Issue-sync is an automated tool for synchronizing GitHub and JIRA issues. |
There was a problem hiding this comment.
it;s not an automated tool until you add actual automation. It is automatable. just say issue-sync is a tool for ...
README.md
Outdated
| ## Usage | ||
|
|
||
| To use, first ensure you have a JIRA server with the project you want | ||
| to track on it - it can be a cloud account, or self-hosted. As well, |
There was a problem hiding this comment.
s/As well/Also. it's a little funny
README.md
Outdated
|
|
||
| To use, first ensure you have a JIRA server with the project you want | ||
| to track on it - it can be a cloud account, or self-hosted. As well, | ||
| make sure you have a user account which can access the project and |
There was a problem hiding this comment.
a user account that can access...
that qualifies or refines a selection, while which describes it
README.md
Outdated
| create issues on it; it's recommended that you create an account | ||
| specifically for the issue-sync tool. | ||
|
|
||
| To the project, add the following custom fields: `GitHub ID`, `GitHub |
There was a problem hiding this comment.
Simplify: Add the following custom fields to the project. Inverting the sentence and separating it into to clauses is extra confusing
README.md
Outdated
|
|
||
| To the project, add the following custom fields: `GitHub ID`, `GitHub | ||
| Number`, `GitHub Labels`, `GitHub Status`, `GitHub Reporter`, and `Last | ||
| Issue-Sync Update`. These fields are required, and the names must match |
README.md
Outdated
| fields, `Last Issue-Sync` update must be a date time field, and the | ||
| remainder must be text fields. | ||
|
|
||
| Arguments to the program may be passed on the command line, or in a |
README.md
Outdated
| repo-name|string|"coreos/issue-sync"|true|null | ||
| jira-uri|string|"https://jira.example.com|true|null | ||
| jira-project|string|"SYNC"|true|null | ||
| since|string|"2017-07-01"|false|"1970-01-01" |
There was a problem hiding this comment.
these use ISO format now, right?
README.md
Outdated
| jira-project|string|"SYNC"|true|null | ||
| since|string|"2017-07-01"|false|"1970-01-01" | ||
|
|
||
| Note that the repo-name must include the owner and repo, that jira-uri |
There was a problem hiding this comment.
quote the key names to show that they are special values and not English
README.md
Outdated
|
|
||
| Note that the repo-name must include the owner and repo, that jira-uri | ||
| is the base URI of the JIRA instance, that jira-project is the project's | ||
| Key, not its name, and that since is in the format "YYYY-MM-DD". |
README.md
Outdated
|
|
||
| After a successful run, the current configuration, with command line | ||
| arguments overwritten, is saved to the configuration file (either the | ||
| one provided, or `$HOME/.issue-sync.json"); the "since" date is updated |
squat
left a comment
squat
left a comment
There was a problem hiding this comment.
Great. squash the README commits and this could be merged as soon as you like. if the functionality it describes depends on the previous PRs, then lets wait until those land.
The README likely needs some futher cleaning up and some clarification, but this version at least explains how the tool works and how to use it.
2 participants
Depends on #6.
Now that heavy work has been done on the tool, its usage needs to be documented.