This document is a new contributor guide, which outlines the requirements for contributing to this repository.
To get an overview of the project, read the README. For more information on devfiles, check the official devfile docs.
By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.
The following are required to work on devfile library:
- Git
- Go 1.21 or later
Before contributing to this repository, see contributor code of conduct
If you spot a problem with devfile library, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
For writing the code just follow Go guide, and also test with testing. Remember to add new unit tests if new features have been introducted, or changes have been made to existing code. If there is something unclear of the style, just look at existing code which might help you to understand it better.
To run unit tests and api tests. Visit library tests to find out more information on tests
make test
Note: All commits must be signed off with the footer:
Signed-off-by: First Lastname <[email protected]>
You can easily add this footer to your commits by adding -s when running git commit.
When you think the code is ready for review, create a pull request and link the issue associated with it. Owners of the repository will watch out for and review new PR‘s. By default for each change in the PR, Travis CI runs all the tests against it. If tests are failing make sure to address the failures. If comments have been given in a review, they have to get integrated. After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github.
Executing ./scripts/updateApi.sh fetches the latest github.com/devfile/api go mod and updates the schema saved under pkg/devfile/parser/data
The script also accepts a version number as an argument to update the devfile schema for a specific devfile version. For example, running the following command will update the devfile schema for 2.0.0
./scripts/updateApi.sh 2.0.0
Running the script with no arguments will default to update the latest devfile version.
Currently devfile library publish new releases annually. A new version can also be generated and released on demand.
A new branch is expected to be created for a new release.
To generate a changelog for a new release, execute ./scripts/changelog-script.sh v2.x.y for all the changes since the release v2.x.y