Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

37 lines (29 loc) · 1.57 KB
Raw

Contributing

This project is open for contributions only from the robolaunch users for now. To request a new image or feature, please consider opening an issue.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Adding a Pipeline

  • First, create an issue for your request in this format: eg. Add Pipeline for Freecad
  • Create a branch using the issue number: eg. 23-freecad
  • Push the empty branch, and then link it to your issue: eg. git push origin 23-freecad
  • Do your changes, commit & push them to your branch.
    • Add your Dockerfiles under dockerfiles/.
    • Add your pipeline configuration under pipelines/.
    • Avoid rebuilding existing images.
    • Version your components and images, use build arguments for seperating them.
  • Open a pull request for merging your changes. eg. from 23-freecad to main

Commit Styling

Use semantic commit messages:

# examples
# ........
# use feat for adding a new component
git commit -m "feat(freecad): add dockerfile and pipeline for freecad images"
# use refactor for small changes
git commit -m "refactor(freecad): change linux user in dockerfile"
# use fix for small changes
git commit -m "fix(freecad): fix dockerfile syntax error"