Template GH project to ease creation of new contrib repos

Development
1

Hi devs,

@surli suggested to use Creating a template repository - GitHub Docs for creating GH contrib projects to simplify the process.

So the proposal is to:

  • Create a GH template repo in XWiki Contrib · GitHub, named template (or template-repository. Any better name?)
  • Inside, provide the following files at the root:
    • README.md
    • LICENSE
    • SECURITY.md
    • .gitignore
    • CONTRIBUTING.md
    • Jenkinsfile
  • Also configure it properly:
    • Uncheck the “wiki”, “issues” and “projects” checkboxes in the settings
    • Add the xwikiorg group in the “Manage Access” settings. Make sure to select the “Write” permission (it’s “Read” by default).
    • Under “Notifications”, add the notifications AT xwiki DOT org email
  • Update https://contrib.xwiki.org/xwiki/bin/view/Main/WebHome#HGitHubRepositoryCreation to use it

WDYT?

Thanks

2

+1 thanks

or template-repository

I prefer this one, it’s more explicit.

3

+1 thanks
Since the templates are Github specific, wdyt of github-template-repository?

4

+1 in general to add a repository template

Not sure about that one, I tend to add it only when the repository is in a state in which it’s starting to make sense to build it on the CI.

5

+1 better be very explicit to avoid blocking some possible project names

6

I still think it’s a good idea to have it, as an indication that we need one eventually. We could comment out the content so that it doesn’t build by default.

Since the templates are Github specific, wdyt of github-template-repository ?

Sounds like a good idea.

7

It’s now implemented:

Thanks

1 Like