Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 1.97 KB

CONTRIBUTE.md

File metadata and controls

25 lines (22 loc) · 1.97 KB
Raw

Contribute to improve these modules

To contribute to any of the modules follow these instructions:

  1. Clone or fork the repository, this will get all the modules. Please, do not include code changes from other modules in a branch or pull request for a specific module.
  2. Create a branch using the following naming convention: (feat|fix|doc)/module/short_description
    • Prefix the branch name with feat for features, fix for fixes and doc for documentation changes. If you have other category let us know or use the closer existing one.
    • The module section is the name of the module, for example: roks, cp4mcm, cp4app or cp4data.
    • This branch should be ONLY to make changes in one module. If there is an exception please, document it well and make sure there are no conflicts. Discuss and confirm with the modules owners the changes.
  3. Set the IBM Cloud credentials as explained here.
  4. To test module changes, run the example in the examples/<cp_name> directory
  5. Execute terraform fmt -recursive before committing the code.
  6. If all the tests pass and you are ready to release the change, open a pull request:
    • Name the PR similar to the branch, following the naming convention: ([FEATURE]|[FIX]|[DOC]) module: Short Description, example: [FEATURE] cp4data: update installer URL
    • Include the labels that apply to this PR
    • Assign the PR to yourself
    • If the PR is not ready to be merged, create it as a Draft
    • Fill out all the required information in the PR description and add as much information as possible.
  7. When the PR is ready to be merge, change it from Draft to Pull Request
  8. Add the contributors or module owners as Reviewers
    • Wait for them to review and approve the changes
    • If there is any suggested change, apply the changes or discuss them in the branch comments
  9. Merge the pull request
  • TODO: Include in the instructions the steps to follow if the developer is not a collaborator of the project