Skip to content
This repository has been archived by the owner on Jun 16, 2022. It is now read-only.

contributions

laher edited this page May 2, 2013 · 1 revision

Contributions

Contributions are most welcome. I'll gladly add people onto the project after a significantly useful pull request.

Guidelines

Any help is gratefully received.

  • Please perform usual gofmt and govet checks on any pull requests.
  • Please don't break any Public APIs without raising a github 'issue' first. (Sorry I have broken this rule many times, but I expect to phase out this behaviour as from version 0.7).
  • Pure Go code only (for now) please.
  • Preferably all code should
  • Please check everythig still works, and please test on multiple host platforms.

Suggestions

Please see todos for some specific ideas.

Some more general suggestions:

Tasks

  • New tasks. Please add a task to do whatever you want.
  • Improve existing tasks. Add options.
  • Break a task into subtasks - i.e. replace the task with an 'alias', pointing to multiple subtasks.
  • Extract some task functionality into a separate package, for re-use outside of goxc.
  • Parallelize a task.

Core

  • Make existing code more idiomatic, efficient, obvious.
  • Pad out existing APIs (typeutils is pretty sparse).
  • Generalise existing code for re-use.

Other

  • Docs, test cases, testing, feedback, suggestions, all that kind of thing.

Props

Thanks will be added to the README.md. Please feel free to add yourself as part of your pull request.

Thanks very much.

Clone this wiki locally