Beta Release Work - Githubissues

amaatouq / netwise

open source project to tackle the problem of long development cycles required to produce software to conduct multi-participant and real-time human experiments online.

1 stars 0 forks source link

Beta Release Work #29

Open npaton opened 6 years ago

npaton commented 6 years ago

Some tasks to think about:

[x] Create a new Github organization for empirica platform (only one repo, could be more, in any case, good to be separate from personal accounts). Orgs are free for open source. Something like github.com/empiricaly is available.
[x] Rename netwise everywhere in the app to Emprica
[x] Separate the website (emprica.ly) from the framework (i.e., app) into two different repositories
[x] Cleanup git history. We have some binaries in there we might not want, and we can just trim the whole history I think.
[x] Update website with the link to repo
[x] Start versioning at v0.1.0 and create a changelog
[ ] add (at least basic) documentation on the website: concepts, structure, maybe some game development documentation (get/set, timers, breadcrumb...)
[x] tell everyone about it :)

npaton commented 6 years ago

@amaatouq Take a look at these when you get a chance, feel free to add, remove edit tasks.

npaton commented 6 years ago

@amaatouq I am not sure where the empirca Github organization is, I just noticed, I do not have access to it, so I can't start moving things over to it. ;)

npaton commented 6 years ago

For the versioning I propose we use Semantic Versioning and Keep a Changelog. We can do this quite quickly when we work on moving the minimal version over this week. Only takes 5 minutes to start. Then it's pretty easy to keep it up if we get into the habit and it is extremely useful for people using and contributing to the open source project. Take a look a the links if you aren't familiar, it's pretty short and simple. ;)

npaton commented 6 years ago

[ ] Downloading empirica (i.e., as opposed to cloning an example) should be very minimal and super lightweight (i.e., we should create an empty skeleton of a game) .. something like when you create a new Meteor project and you get the default app with the 'clicks counter.' This would mean avatars will be only included in the 'examples' repository and not the main framework repository.

For this one, which type of usage should encourage: to download, clone or fork. If they clone or fork, they can (relatively) easily update the core. If they download without the git context, merging becomes very difficult, so if they encounter a bug we have since fixed in the core, they will have a hard(er) time getting to it.

Eventually, maybe there is even a better method than all this, but for now, using the existing strengths of Git might be wise.

npaton commented 6 years ago

@amaatouq Only 2 tasks remaining: minimal docs and telling people. I don't if either are blocking the beta. If they aren't we can put them in other issues if needed, I let you determine that. ;)