search

ga-wdi-remote / HOW-TO-USE-THIS-ORG

READ FIRST: How to contribute, repo naming conventions, and content/solution styleguide
0 stars 0 forks source link

Need better naming conventions for tracking different versions of content #1

Open ColinTheRobot opened 7 years ago

ColinTheRobot commented 7 years ago

Currently, contribution documentation asks instructors to create a branch with their name and whether it's master or solution. This isn't particularly descriptive and doesn't inform other instructors as to what's different about that version vs another.

Possible options are using git branch descriptions using git branch --edit-description but this requires everyone set up a script to see the description since they're only listed in the git config file.

http://labs.6dglobal.com/blog/2015-02-19/taking-advantage-git-branch-descriptions/

We could create an installation script that sets this up easily.

Other options are:

  1. create more verbose naming conventions for branches
  2. ask that instructors create an issue that describes the lesson and the branch name
ColinTheRobot commented 7 years ago

The issue being that I have sql and nosql versions of the same lesson. How do we keep track of different versions of the same content within the same repo?

hizegi commented 7 years ago

Suggestions:

For repos with multiple branches, or for every new branch being added, the contributor could

  1. create a new issue (ie. titled with the branch name ie. "branch: version 2") OR
  2. Add to the wiki that lists branch names.

Then we can come up with the style conventions for those (title, naming, description, outline, features, differences, etc)

ColinTheRobot commented 7 years ago

I like the idea of issues.

We could just have one pinned issue that people add to as they add versions etc. vs having multiple