The purpose of this project is to provide a template for new open source repositories.
This repository contains some example best practices for open source repositories:
These are optional
- dco.yml - This enables DCO bot for you, please take a look https://github.com/probot/dco for more details.
- travis.yml - This is a example
.travis.yml, please take a look https://docs.travis-ci.com/user/tutorial/ for more details.
These may be copied into a new or existing project to make it easier for developers not on a project team to collaborate.
NOTE: While this boilerplate project uses the Apache 2.0 license, when establishing a new repo using this template, please use the license that was approved for your project.
NOTE: This repository has been configured with the DCO bot. When you set up a new repository that uses the Apache license, you should use the DCO to manage contributions. The DCO bot will help enforce that. Please contact one of the IBM GH Org stewards.
If you have any questions or issues you can create a new issue here.
Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:
- Fork the repo
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
All source files must include a Copyright and License header. The SPDX license header is preferred because it can be easily scanned.
If you would like to see the detailed LICENSE click here.
#
# Copyright IBM Corp. {Year project was created} - {Current Year}
# SPDX-License-Identifier: Apache-2.0
#
Optionally, you may include a list of authors, though this is redundant with the built-in GitHub list of contributors.
- Author: New OpenSource IBMer [email protected]