diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f42e2d70e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# Contributing + +Contributions are welcome! + +## Code of Conduct + +Before contributing to this repository for the first time, please review our project's [Code of Conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md). + +## Getting Started + +### Issues + +- Open or search for [issues](https://github.com/devfile/api/issues) with the label `area/api`. + +- If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/devfile/api/issues/new/choose). You can tag issues with `/area api`. + +### Building + +To build the CRD and the various schemas, you don't need to install any pre-requisite apart from `docker`. +In the root directory, just run the following command: + +``` +./docker-run.sh ./build.sh +``` + +### Testing + +Find more information about tests in the [testing document](test/README.md). + +``` +# schemaTest approach +cd test/v200/schemaTest +go test -v +``` + +``` +# apiTest approach +cd test/v200/apiTest +go test -v +``` + +### Pull Requests + +All commits must be signed off with the footer: + +``` +Signed-off-by: First Lastname +``` + +Once you set your user.name and user.email in your git config, you can sign your commit automatically with git commit -s. 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 PRs. + +If comments have been given in a review, they have to be addressed before merging. + +After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review. diff --git a/README.md b/README.md index 28c653eec..b06e96e54 100644 --- a/README.md +++ b/README.md @@ -63,3 +63,11 @@ As soon as the devworkspace is opened, you should be able to: - `samples/` - `devfile-support/samples` - have `yaml` language support (completion and documentation) based on the current Json schemas. + +## Contributing + +Please see our [contributing.md](./CONTRIBUTING.md). + +## License + +Apache License 2.0, see [LICENSE](./LICENSE) for details.