speckleworks / speckleorg Goto Github PK

Following up on the discussion on #semver slack channel and semver issue raised on SpeckleRhino, we should discuss appropriate branching schemes for Speckle Repos. Here are some references shared by @pearswj and @didimitrie :

• https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
• http://nvie.com/posts/a-successful-git-branching-model/
• http://scottchacon.com/2011/08/31/github-flow.html
• https://guides.github.com/introduction/flow/
• https://github.com/octokit/octokit.rb#versioning

As requested by @Eckart-S, we should create a guide for creating plugins. It should contain what can be a submodule, info about Speckle*Converter development, info about Interop, info about the UI.

Currently they're spread out on the website. I've taken that off the main page as most of the docs got outdated and i didn't have time to polish them up, and they ended up confusing users.

There's also a beginning of a tutorial here on the speckle core wiki.

The sublayer questions:

• what docs do we need?
• where do we want to keep them?
• how should we make sure we can update them fast and easy?

• https://github.com/speckleworks/SpeckleGrasshopper
• https://github.com/speckleworks/SpeckleRhinoConverter
• https://github.com/speckleworks/SpeckleAccountManager
• https://github.com/speckleworks/SpeckleUserDataUtils

they're confusing people apparently, and considering the legwork needed for #3 it might be a good move. up for debate

Contribution guidelines should make mention of using github issue # in commit and PR message.

We should have a template for what to add in the READMEs, especially mentions to H2020 Innochain, etc., License, Contrib, etc.