gpm/templates/issues.org

Git Project Management Issues

• Basic Usages
  • Do thing 3
  • Do thing 2
  • Do thing 1
• Issues
  • Basic review process
    • Review finished
      • Changed!
  • Write a CONTRIBUTING file
    • Advanced review workflow explained!
  • Write a tutorial
  • Write Install section in README
  • Write README file

This is an example on how to organize the issues. The basic usage is quite simple, only use 3 status (todo, started, done)

The second section "Issues" show a more advanced usage which once you're used to org-mode shouldn't be too hard to follow. Mainly the idea is simply to add tags and properties. You can use tags as github labels. And think about properties to manages meta datas such as:

• Assignee (who is assignee to an issue)
• Reviewers (who is asked for review)
• branch (the branch asked for a review before merge)

Basic Usages

The basic usage is to simply create the todo list. The reviewers could simply add sub items to provide remarks or even other todos.

TODO Do thing 3

STARTED Do thing 2

DONE Do thing 1

CLOSED: [2018-08-28 Tue 22:37]

Issues

If you use org-sort it will put the REVIEW task on top. Then FEEDBACK (when you simply need to ask questions).

REVIEW Basic review process

So basically the reviewer should write his review here. As the reviewer should switch branch to the working branch the issues.org file won't be easy to reach.

So it is up to the user to create a file ~/.reviews/<branch-name>-<reviewer>.org The reviewer then will only need to write down its remarks. To make things easy you can link the files with their lines using file:path/to/file:::NNN.

Once the review is finished. The reviewer simply need to:

1. switch to the gpm branch
2. copy the review file into the reviews/ directory
3. make a commit aboute the finished review.

The contributor will then be able to copy the content of reviews/ into ~/.reviews/, switch to the branch to be merged, read the review, make fixes, add comment to the review files, etc…

ACCEPTED Review finished

Please change something

edit: switched from CHANGE_REQUESTED to ACCEPTED!

FEEDBACK Changed!

MERGED Write a CONTRIBUTING file   doc

CLOSED: [2018-08-28 Tue 22:51]

ACCEPTED Advanced review workflow explained!

A simple way to write and read review is to use org-capture. It will create a file with links to the file your are inspecting in emacs without modifying the file.

A simple way to achieve this would be to create a reviews directory: mkdir ~/.reviews

Then in the next section Use C-c C-c to execute that and so you'll see all annotations.

Mainly the reviewer only need to use org-capture and put the result in reviews.

;; (load "../gpm-review-0.0.1/gpm-review.el")
(require 'gpm-review)

1. Start by using C-c C-c here.
2. Switch to the issue branch.
3. If you just want to read the review open the (gen-review-file-name)
4. If you want to add a remark use org-capture to open the org file that will contain your remarks with a link to the line and file. I think to make it easier all member of the team should put their projects in the same place. Typically ~/dev/project-name.

(concat "[[~/.reviews/" (gen-review-file-name) "]]")

[[~/.reviews/write-contributing-yogsototh.org]]

(start-review)

(end-review)

TODO [B] Write a tutorial   doc

Should contains a complete tutorial

WAITING [A] Write Install section in README   ops doc

Explain how to install the project

DONE Write README file   doc

The goal is to write a text file with all informations about the project

Shubby: @Alex should I write a subtitle? Alex: @Shubby I think you can"