First draft of an (almost) universal project template #1
Conversation
This commit represent a first stab at a template for open source software projects under the Zambezi banner. It adds sensible defaults for most things, and elsewhere specifies where things should change. The rationale can probably further explain *why* some choices were made (such as why MIT, for instance) but other than that this is probably a pretty complete collection of files. Note that this does not include notably specific files such as project.json, .gitignore, and others. We may want to add those, but we may not, and just create forks of this project, that are effectively variants. (E.g. for a node project, it might be zambezi/project-node, or some such.)
mstade
changed the title
|
@zambezi/contributors I'd love to have your input on this PR, to see if there's anything missing, or whether this need fixing. I think it's pretty extensive as a first cut of a foundation for all our open source projects, but undoubtedly it can improve. |
The note about following the code of conduct seemed redundant and passive aggressive, so I removed it as well.
These should provide a good enough base for most software projects.
The absolute URLs would make it too easy to forget to change things specific to the template. With this change, it shouldn't matter since the links would be relative to the file.
These instructions are like a poor mans templating solution, in lieu of a more complete solution. The benefit to this is that the only dependency is `git`, which is a nice place to be.
|
|
||
| To create a new project: | ||
|
|
||
| 1. Clone (or download) this project: `git clone [email protected]:zambezi/project.git your-project` |
There was a problem hiding this comment.
Could we produce a GitHub release of this project (once PR merged) with a zip attached that contains the minimal files for getting started?
With a zip, the instructions for getting started could be simplified (no .git directory deleting).
There was a problem hiding this comment.
You're right, and when you're right, you're right! :o)
Updated to much simpler instructions in d7ac692.
Thanks for the suggestion, @matthewdunsdon! :o)
|
@mstade , I like this a lot. Even though there's no code here, it already feels like a mature project just from the format and the tone 👍 |
|
Awesome, that's what I was going for – thanks @gabrielmontagne! :o) |
|
Unless there's any more feedback on this, I'll merge and release v1.0.0 and start overlaying this on the other repos in the org. |
|
Yeah it's all good stuff! |
This work represents a first stab at a template for open source software projects under the Zambezi banner. It adds sensible defaults for most things, and elsewhere specifies where things should change.
The rationale can probably further explain why some choices were made (such as why MIT, for instance) but other than that this is probably a pretty complete collection of files.
Note that this does not include notably specific files such as project.json, .gitignore, and others. We may want to add those, but we may not, and just create forks of this project, that are effectively variants. (E.g. for a node project, it might be zambezi/project-node, or some such.)
Demo: https://github.com/zambezi/project/tree/v1