a plan to revitalize maint/dev #335

Open
trentm opened this Issue Jan 22, 2016 · 7 comments

Comments

Projects
None yet
3 participants
@trentm
Owner

trentm commented Jan 22, 2016

A plan to get out of the current node-bunyan issue/PR pile and get the
project feeling more healthy. I've had some informal offers to help in maintenance work, hence a
number of steps to try to make that feasible.

  • Get a CONTRIBUTING.md commited to start documenting how people could help, or at least understand.
  • blog post: http://trentm.com/2016/01/node-bunyan-maintenance.html
  • Add some categorization to the issue tracker. The point being to more easily answer "what should be worked on now? what can be left for later?" See the Issue labels docs. I'm working through the needslabels label now.
  • Triage every current issue and PR. This'll require me to try to be less polite. Will use needstriage label for this.
  • Document my requirements for added work: docs, tests, changelog. I find a lot of time integrating PRs is on these parts. Without documenting this I can't expect to get help. (At least partially covered in CONTRIBUTING.md.)
  • Get automated testing going on various platforms (currently done manually and for limited plats) and node versions (currently somewhat done by 'make test'). Issue #342.
  • Switch to eslint for better handling of lint and style. Josh's starter config (https://github.com/joyent/sdc-vm-agent/blob/master/.eslintrc). Suspect I'll have my own tweaks to that. Issue #341.
  • Outline a roadmap.
@ericelliott

This comment has been minimized.

Show comment
Hide comment
@ericelliott

ericelliott Jan 22, 2016

Haha, I came here to ask what the status was and ask if you'd be willing to allow more people to commit and merge pull requests. I'm a big fan of Bunyan (I wrote about it in my O'Reilly Book, "Programming JavaScript Applications"), and I'm interested in seeing it continue as a viable choice.

Questions:

  • I don't see any automated checks. If you have an npm test script that works out of the box after npm install, setting up CircleCI or Travis is a few button presses. Could you set that up say, tomorrow? =)
  • Would you be willing to look at dependency upkeep using Greenkeeper? After the automated checks are set up, it will automatically open PRs. If the PR passes the check, you just click "merge", and it's done. If it doesn't, close the PR and upgrade the dependency manually.

Haha, I came here to ask what the status was and ask if you'd be willing to allow more people to commit and merge pull requests. I'm a big fan of Bunyan (I wrote about it in my O'Reilly Book, "Programming JavaScript Applications"), and I'm interested in seeing it continue as a viable choice.

Questions:

  • I don't see any automated checks. If you have an npm test script that works out of the box after npm install, setting up CircleCI or Travis is a few button presses. Could you set that up say, tomorrow? =)
  • Would you be willing to look at dependency upkeep using Greenkeeper? After the automated checks are set up, it will automatically open PRs. If the PR passes the check, you just click "merge", and it's done. If it doesn't, close the PR and upgrade the dependency manually.
@trentm

This comment has been minimized.

Show comment
Hide comment
@trentm

trentm Jan 22, 2016

Owner

@ericelliott Thanks for the notes. Yes, I'm hoping to get there to have other maintainers here.

There is make test, not hooked up to 'npm test' with a "scripts" section -- but I'm happy to do that for some service integration. I have a ticket coming for choosing an automated testing service to possibly use. I'll put those details there.

Greenkeeper: Probably yes. I've seen it, but haven't used it yet in any projects I work on.

The just client "merge" reminded me that I'll want something to disable that button. ;) I want to have merges result in a flat #master history like this:

* 4619d33 - (HEAD -> master, origin/master, origin/HEAD) prep for future dev (5 months ago) <Trent Mick>
* 49891f4 - (tag: 1.5.1) prepare for 1.5.1 release (5 months ago) <Trent Mick>
* 3554d80 - fix 'make versioncheck' broken in prev commit (5 months ago) <Trent Mick>
* 77e239c - drop redundant 'bunyan' from changelog release entries as I've moved to in other projects (5 months ago) <Trent Mick>
* 86b6769 - Fix `src: true`, which was broken in v1.5.0. (5 months ago) <Trent Mick>
* 2975178 - prep for future dev (5 months ago) <Trent Mick>
* e14f191 - (tag: 1.5.0) prepare for 1.5.0 release (5 months ago) <Trent Mick>
* 27d6057 - strict mode (5 months ago) <Trent Mick>
* 6baeb2c - Add license attribute (5 months ago) <Peter deHaan>
* 9cd7047 - Added the missing syntax highlighting (5 months ago) <Ionică Bizău>

as opposed to this:

*   257d324 - (HEAD -> master, origin/master, origin/HEAD) Auto merge of #30980 - gereeter:fix-btree-iter-variance, r=apasel422 (5 days ago) <bors>
|\
| * 7a9c4a4 - Expand the macro in variance-btree-invariant-types.rs to make compiletest recognize that it should error (5 days ago) <Jonathan S>
| * fae75c9 - Fix and test variance of BTreeMap and its companion structs. (5 days ago) <Jonathan S>
* |   d0bac3f - Auto merge of #30973 - SimonSapin:patch-16, r=alexcrichton (5 days ago) <bors>
|\ \
| * | f09bcc1 - Fix SocketAddrV6::flowinfo docs (5 days ago) <Simon Sapin>
* | |   4ab9a2d - Auto merge of #30964 - GuillaumeGomez:patch-5, r=Manishearth (5 days ago) <bors>
|\ \ \
| * | | f15512e - Add E0507 error explanation (5 days ago) <Guillaume Gomez>
* | | |   f682639 - (tag: homu-tmp) Auto merge of #30978 - nikomatsakis:fulfillment-tree-add-fixme, r=aturon (5 days ago) <bors>
|\ \ \ \
| |_|_|/

Anyway, I'll open tickets/explain in CONTRIBUTING.md soon.

Owner

trentm commented Jan 22, 2016

@ericelliott Thanks for the notes. Yes, I'm hoping to get there to have other maintainers here.

There is make test, not hooked up to 'npm test' with a "scripts" section -- but I'm happy to do that for some service integration. I have a ticket coming for choosing an automated testing service to possibly use. I'll put those details there.

Greenkeeper: Probably yes. I've seen it, but haven't used it yet in any projects I work on.

The just client "merge" reminded me that I'll want something to disable that button. ;) I want to have merges result in a flat #master history like this:

* 4619d33 - (HEAD -> master, origin/master, origin/HEAD) prep for future dev (5 months ago) <Trent Mick>
* 49891f4 - (tag: 1.5.1) prepare for 1.5.1 release (5 months ago) <Trent Mick>
* 3554d80 - fix 'make versioncheck' broken in prev commit (5 months ago) <Trent Mick>
* 77e239c - drop redundant 'bunyan' from changelog release entries as I've moved to in other projects (5 months ago) <Trent Mick>
* 86b6769 - Fix `src: true`, which was broken in v1.5.0. (5 months ago) <Trent Mick>
* 2975178 - prep for future dev (5 months ago) <Trent Mick>
* e14f191 - (tag: 1.5.0) prepare for 1.5.0 release (5 months ago) <Trent Mick>
* 27d6057 - strict mode (5 months ago) <Trent Mick>
* 6baeb2c - Add license attribute (5 months ago) <Peter deHaan>
* 9cd7047 - Added the missing syntax highlighting (5 months ago) <Ionică Bizău>

as opposed to this:

*   257d324 - (HEAD -> master, origin/master, origin/HEAD) Auto merge of #30980 - gereeter:fix-btree-iter-variance, r=apasel422 (5 days ago) <bors>
|\
| * 7a9c4a4 - Expand the macro in variance-btree-invariant-types.rs to make compiletest recognize that it should error (5 days ago) <Jonathan S>
| * fae75c9 - Fix and test variance of BTreeMap and its companion structs. (5 days ago) <Jonathan S>
* |   d0bac3f - Auto merge of #30973 - SimonSapin:patch-16, r=alexcrichton (5 days ago) <bors>
|\ \
| * | f09bcc1 - Fix SocketAddrV6::flowinfo docs (5 days ago) <Simon Sapin>
* | |   4ab9a2d - Auto merge of #30964 - GuillaumeGomez:patch-5, r=Manishearth (5 days ago) <bors>
|\ \ \
| * | | f15512e - Add E0507 error explanation (5 days ago) <Guillaume Gomez>
* | | |   f682639 - (tag: homu-tmp) Auto merge of #30978 - nikomatsakis:fulfillment-tree-add-fixme, r=aturon (5 days ago) <bors>
|\ \ \ \
| |_|_|/

Anyway, I'll open tickets/explain in CONTRIBUTING.md soon.

@ericelliott

This comment has been minimized.

Show comment
Hide comment
@ericelliott

ericelliott Jan 22, 2016

Very cool. Looking forward to this! =)

Very cool. Looking forward to this! =)

@trentm trentm changed the title from a plan to revitalize main/dev to a plan to revitalize maint/dev Jan 26, 2016

@trentm

This comment has been minimized.

Show comment
Hide comment
@trentm

trentm Feb 1, 2016

Owner

needstriage data points: https://github.com/trentm/node-bunyan/labels/needstriage

  • 2016-02-01T01:18:25Z: 122 open
  • 2016-02-03T16:49:14Z: 112 open
  • 2016-02-11T07:47:39Z: 111 open (keeping up with new incoming ones too)
  • 2016-02-12T16:39:51Z: 104 open
  • 2016-02-21T21:40:44Z: 99 open
  • 2016-02-29T06:47:04Z: 90 open
Owner

trentm commented Feb 1, 2016

needstriage data points: https://github.com/trentm/node-bunyan/labels/needstriage

  • 2016-02-01T01:18:25Z: 122 open
  • 2016-02-03T16:49:14Z: 112 open
  • 2016-02-11T07:47:39Z: 111 open (keeping up with new incoming ones too)
  • 2016-02-12T16:39:51Z: 104 open
  • 2016-02-21T21:40:44Z: 99 open
  • 2016-02-29T06:47:04Z: 90 open

This was referenced Feb 1, 2016

@Khez

This comment has been minimized.

Show comment
Hide comment
@Khez

Khez Feb 2, 2016

Would you be willing to start a room in https://gitter.im/ ?
We should get better communication out of it

Khez commented Feb 2, 2016

Would you be willing to start a room in https://gitter.im/ ?
We should get better communication out of it

@trentm

This comment has been minimized.

Show comment
Hide comment
@trentm

trentm Feb 3, 2016

Owner

@Khez I started a unscientific and undemocratic poll here: https://twitter.com/trentmick/status/694924258124787713 Undemocratic because personally my preference is for IRC because I don't think I'd realistically keep a tab open for Gitter and keep up to date there. Also, FWIW, there is already a #bunyan IRC room on freenode.net.

Owner

trentm commented Feb 3, 2016

@Khez I started a unscientific and undemocratic poll here: https://twitter.com/trentmick/status/694924258124787713 Undemocratic because personally my preference is for IRC because I don't think I'd realistically keep a tab open for Gitter and keep up to date there. Also, FWIW, there is already a #bunyan IRC room on freenode.net.

@trentm

This comment has been minimized.

Show comment
Hide comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment