Hi,
Recently, we made significant updates to the wiki:
Patrick
The CLA info is now in the Contributing Code Section of the Contributor’s Guide - https://github.com/AnalyticalGraphicsInc/cesium/wiki/Contributor’s-Guide. We are now fully ready for contributions.
Patrick
Hello all,
I’ve recently added Quick Start and Contributor’s guides (similar to those for Cesium) to the czml-writer Wiki - https://github.com/AnalyticalGraphicsInc/czml-writer/wiki. If anything is unclear or lacks enough detail to get you up and running, please let me know.
In the coming days I’ll begin work on a czml-writer architecture guide. As always, your feedback and revisions are appreciated.
Thanks,
Kristian
Kristian,
This is a really useful contribution. I haven’t read the Contributor’s Guide yet, but here are a few comments on the Quick Start:
- Consider organizing it by .NET and Java, not Build and Test. Think about how a reader will want to navigate the document; they only care about their language of choice.
- Does the .NET version work with Visual Studio Express?
- “Build - Build Solution (Ctrl + Shift + B) or Build - Build All (F8) to compile all included projects.”
- Is this for different versions of Visual Studio? Otherwise, for the Quick Start, readers don’t need options. Give them one way to build; not two (well, four). Same comment for Java.
- For running the unit tests, say exactly how to do it, e.g., install NUnit if they don’t have it, run it, and load such and such .dll, etc. Also, TestDriven.NET is a paid product. I wouldn’t even mention it; if a user has it, they’ll know how to run the tests assuming they know where the tests are.
Patrick
- Consider organizing it by .NET and Java, not Build and Test. Think about how a reader will want to navigate the document; they only care about their language of choice.
- “Build - Build Solution (Ctrl + Shift + B) or Build - Build All (F8) to compile all included projects.”
- Is this for different versions of Visual Studio? Otherwise, for the Quick Start, readers don’t need options. Give them one way to build; not two (well, four). Same comment for Java.
The two different build commands (and their shortcuts) were for each of the IDEs mentioned in the previous two bullets. Reorganizing by .NET and Java will help remove some of this confusion and increase the parallelism between instructions. Great idea!
- For running the unit tests, say exactly how to do it, e.g., install NUnit if they don’t have it, run it, and load such and such .dll, etc. Also, TestDriven.NET is a paid product. I wouldn’t even mention it; if a user has it, they’ll know how to run the tests assuming they know where the tests are.
Will do. I did look into TestDriven.NET before adding it to the guide. The free personal version that’s available for download is listed for use by open source developers, though I can see where a gray area exists if a developer is tied to a company/organization and is contributing to the project. If this is the case we’re trying to avoid, I’ll remove that comment.
Thanks,
Kristian
I didn’t know about the free version of TestDriven.NET. I’d still provide instructions for NUnit, and just link to TestDriven.NET as another tool (or maybe just do that in the more detailed Contributor’s Guide). Even though there is a gray area for some developers, many developers, like students and hobbyists, will be able to use the free version.
Patrick