10 Nov
2015
10 Nov
'15
3:50 p.m.
+1
Thanks,
Eduard
On Tue, Nov 10, 2015 at 4:40 PM, Thomas Mortagne <thomas.mortagne(a)xwiki.com>
wrote:
Looks good.
The LICENSE is already discussed somewhere else.
On Tue, Nov 10, 2015 at 3:37 PM, Ecaterina Moraru (Valica)
<valicac(a)gmail.com> wrote:
Hi,
Currently we don't provide any README files for the repositories found on
https://github.com/xwiki
There are several remarks about this fact:
- README is promoted by GitHub as the way to summarize your project. That
green button "Add a README" won't disappear unless we create a file :)
- All the other major organizations provide READMEs for their
repositories,
even if they have dedicated websites (a.k.a the
README is not the only
way
to document your project).
I think we should provide a README that contains just:
- Summary for the repo
- Links to the xwiki.org wiki about that particular repo
-- the links should be general and easy to maintain
-- they should facilitate access to devs for the most useful pages on
xwiki.org, promoting development and contributions.
I've created these proposals:
- Enterprise https://gist.github.com/evalica/b439c6dc98ca109e1f5b
- Platform https://gist.github.com/evalica/6431b99514d59bb7b66f
- Rendering https://gist.github.com/evalica/79298c6830480eff321d
- Commons https://gist.github.com/evalica/2affcfff5a4a40b418aa
The custom parts for each repository are Summary, Documentation,
Download.
The generic parts are Release Notes, Tools,
Community.
Let me know what you think.
Thanks,
Caty
P.S. For the LICENSE file we could just provide a link to the xwiki.org
page, see https://gist.github.com/evalica/8d58ec8353a30cad3386
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
--
Thomas Mortagne
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs