Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Instructions for adding badges

...

  • README.md - brief description of the module
  • LICENSE - the standard Apache-2.0 license file (available in the sling-aggregator repo)
  • CODE_OF_CONDUCT.md - reference to the Apache Software Foundation code of conduct (available in the sling-aggregator repo)
  • CONTRIBUTING.md - reference to the Apache Sling contribution guidelines (available in the sling-aggregator repo)
  • Jenkinsfile - delegates to the Apache Sling Pipeline library ( example available in all repos, for instance see the Jenkinsfile for the sling-org-apache-sling-api repository )
  • .gitignore
  • .asf.yaml for Github metadata, see git - .asf.yaml features
    • tags: include initially sling  and java  (or other programming language, as applicable )
    • homepage: module documentation on Sling website, or the Sling homepage if none exists
    • description: the name from the pom.xml 

Badges

The sling-aggregator/add-badges.sh script automates the creation of badges for the README. You will need a valid GitHub token for it. To add the badges for just a single repository, run.

Code Block
$ ./add-badges.sh ../ ${NEW_REPO}

Enroll in Kibble

The repository should be added as a source in the Apache Kibble dev instance to make sure development statistics are collected from it. The Kibble dev instance repository list should be refreshed periodically, but if you don't see the data in a week or so ask on dev@kibble.apache.org about it.

...