docs(HMS-2680): add contributing guidelines

.github/workflows/main.yml

@@ -22,10 +22,3 @@ jobs:
           touch *.yaml
           make generate-json
           git diff --exit-code
-
-  oapi_codegen:
-    runs-on: "ubuntu-latest"
-    container: registry.access.redhat.com/ubi9/go-toolset:1.20
-    steps:
-      - uses: "actions/checkout@v3"
-      - run: make oapi-codegen

CONTRIBUTING.md

@@ -0,0 +1,145 @@
+# Contributing to idmsvc-api
+
+The main way to contribute is providing changes to the repository, but not the
+only one. If you see something wrong in the repository, a question or some
+feature you would like to see, create an issue is another way you can help.
+
+## Getting Started
+
+The repository is using [Github flow][github_flow].
+
+- [Fork][fork_repo] the repository in your namespace.
+- Clone the repository locally.
+- Create a branch: `git checkout -b my-cool-changes`
+- Add changes using your favourite editor or by: `make swagger-editor`
+  - To stop swagger-editor container run: `make swagger-editor-stop`
+- Sort the changes by: `make openapi-sort`
+- Update json files by `make generate-json`
+- Check the changes by: `make validate vacuum`
+- Rebase, push changes to your forked repository, and create a PR.
+- Update changes from the review until you get an ACK.
+- Merge your changes :)
+
+## Reporting bugs
+
+- **Be sure you are using the last version of our openapi specification**.
+- Please if you think it is a bug that is a security issue, see
+  [SECURITY.md](../SECURITY.md)
+- Else, before create a new issue, please [search][search_issues]
+  into the current issues to check if it already exists.
+
+Then it looks a new or request for enhancement, so please create a new issue
+and fill the next template for a BUG.
+
+<!--
+TODO When create an issue is enabled in GitHub,
+     remove the template below and put in a
+     github template.
+-->
+
+```markdown
+### Description
+
+Tell us a summary of the bug.
+
+### Steps to replay
+
+- I do action step 1.
+- I do action step 2.
+- I do action step 3.
+
+What frequency you can replay the issue? (always / specific env / random)
+
+### What is the observed wrong behavior
+
+Tell us what is wrong.
+
+### What is the expected behavior
+
+Tell us what you were expecting instead of the wron behavior.
+
+### Additional information
+
+Please attach any further information such as:
+
+- What commit did you observed this? `git rev-parse --short HEAD`
+- Any other additional information that could be useful to replay and
+  analyse the issue.
+```
+
+Thank you for contributing to get a better software! we will study
+the issue as soon as possible!
+
+## Commit messages
+
+Follow the [conventional commits guidelines][conventional_commits] to *make
+reviews easier* and to make the VCS/git logs more valuable. The general
+structure of a commit message is:
+
+```
+<type>[(optional scope)]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+for instance
+
+```raw
+fix(HMS-9999): response 201 when a domain is registered
+
+This change modified the status code for a success response when it
+registers a domain, returning a 201 (Created) status code, instead
+of 200 (Ok).
+
+Signed-off-by: Alejandro Visiedo <[email protected]>
+```
+
+For a commit that has a github issue scope, the title would be:
+
+```raw
+fix(9999): response 201 when a domain is registered
+```
+
+Further information:
+
+- Prefix the commit subject with one of these [_types_](prefix_types):
+    - `build`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`,
+      `test`, `style`, `chore`.
+    - You can **ignore this for "fixup" commits** or any commits you expect to be 
+      squashed.
+- Append optional _scope_:
+  - For a jira ticket for instance:
+    ```raw
+    fix(HMS-9999): response 201 when a domain is registered
+    ```
+  - For a github issue for instance:
+    ```raw
+    fix(9999): response 201 when a domain is registered
+    ```
+- _Commit title_ shouldn't start with a capital letter or end in a period.
+- Use the _imperative voice_: "Fix bug" rather than "Fixed bug" or "Fixes bug."
+- Try to keep the first line under 72 characters.
+- A blank line must follow the subject.
+- Breaking API changes must be indicated by
+    1. "!" after the type/scope, and
+    2. a "BREAKING CHANGE" footer describing the change.
+       Example:
+       ```
+       refactor(HMS-9999)!: drop support for Python 2
+
+       BREAKING CHANGE: refactor to use Python 3 features since Python 2
+       is no longer supported.
+       ```
+
+### Automated builds (CI)
+
+Each pull request must pass the automated builds, which execute linters, build
+and tests (unit and smoke).
+
+[github_flow]: https://docs.github.com/en/get-started/quickstart/github-flow
+[fork_repo]: https://github.com/podengo-project/idmsvc-api/fork
+[conventional_commits]: https://www.conventionalcommits.org
+[prefix_types]: https://github.com/commitizen/conventional-commit-types/blob/master/index.json
+[search_issues]: https://github.com/podengo-project/idmsvc-api/pulls

Makefile

@@ -36,27 +36,6 @@ $(NODE_BIN)/%: package.json package-lock.json
 	npm install
 	touch $(NODE_BIN)/*
 
-$(OAPI_CODEGEN):
-	GOBIN=$(CURDIR)/$(BIN) go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@$(OAPI_CODEGEN_VERSION)
-
-.PHONY: oapi-codegen
-oapi-codegen: \
-		$(TMP)/public/spec.gen.go $(TMP)/public/server.gen.go $(TMP)/public/types.gen.go \
-		$(TMP)/internal/spec.gen.go $(TMP)/internal/server.gen.go $(TMP)/internal/types.gen.go \
-		$(TMP)/metrics/spec.gen.go $(TMP)/metrics/server.gen.go $(TMP)/metrics/types.gen.go
-
-$(TMP)/%/spec.gen.go: %.openapi.yaml $(OAPI_CODEGEN)
-	@mkdir -p $(dir $@)
-	$(OAPI_CODEGEN) -generate spec -package $* -o $(TMP)/$*/spec.gen.go $<
-
-$(TMP)/%/server.gen.go: %.openapi.yaml $(OAPI_CODEGEN)
-	@mkdir -p $(dir $@)
-	$(OAPI_CODEGEN) -generate server -package $* -o $(TMP)/$*/server.gen.go $<
-
-$(TMP)/%/types.gen.go: %.openapi.yaml $(OAPI_CODEGEN)
-	@mkdir -p $(dir $@)
-	$(OAPI_CODEGEN) -generate types -package $* -o $(TMP)/$*/types.gen.go $<
-
 .PHONY: validate
 validate: $(VALIDATOR)
 	$(VALIDATOR) public.openapi.yaml

README.md

@@ -40,3 +40,7 @@ git submodule update --init
 Set the environment variable `GIT_SUBMODULE_STRATEGY=normal`, e.g. in CI/CD
 variables in the settings menu, see
 [CI docs](https://docs.gitlab.com/ee/ci/git_submodules.html).
+
+## Contributing
+
+Please read our [CONTRIBUTING.md](CONTRIBUTING.md) guidelines.

SECURITY.md

@@ -0,0 +1,4 @@
+# Security response
+
+For any security issue that you have found, please contact to Red Hat Product Security team. Further information at:
+[Security Contacts and Procedures](https://access.redhat.com/security/team/contact).