Skip to content

Contributing rules

Radosław Jajko edited this page Mar 15, 2021 · 5 revisions

Scada-LTS is an open-source project that is under development by SCADA-LTS organization.

Adding a new Feature

  1. Create an new issue with 'Feature Request' template.
    • Define Expected Behavior how that feature should work.
    • Add proper labels to that issue.
  2. Create your own branch
    • Follow the naming conventions: feature/#ISSUE_NUMBER_description etc.
    • Change .travis.yml file and add your branch to branches: only array.
  3. Make your changes
    • Commit your changes.
      Remember to type #ISSUE_NUMBER into the commit description message to be included into GitHub issue reference. Try to keep your commits messages readable.
    • Try to create Unit Tests for your feature.
    • When you finish your feature open a Pull Request to the develop branch.
    • Make sure that all Checks has been passed.
  4. Wait for review
    • Your code will be available as docker container with the same tag as your #ISSUE_NUMBER
    • Wait for approve of the review.
  5. Merge your changes.
    • When PR is approved, soon the Project Owner will merge your changes to the develop branch.

Useful pages:

Useful documentation how to maintain the git workflow.

On that service are stored docker Scada-LTS containers related to specific branches.

If you have got any question about Scada-LTS this is the best place to look for the solution. If you didn't find answer open a new discussion.