Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1007 Bytes

contributing.rst

File metadata and controls

32 lines (20 loc) · 1007 Bytes

Contributing

All development is done on GitHub: https://github.com/BAILOOL/ANMS-Codes

Git Workflow

  • master branch is where all up-to-date stable code is maintained. At this moment it combines master and develop branches in one as there is no need for releases.
  • feature/feature-name is a branch for any improvement, bugs, refactoring or documentation. This branch is the one used to push changes to master through Pull Requests (PR).

To create a pull request:

  1. Fork the repository.
  2. Clone it.
  3. Install Super-Linter:
docker pull github/super-linter:latest
  1. Make desired changes to the code.
  2. Verify new changes pass Super-Linter:
docker run -e RUN_LOCAL=true -e VALIDATE_CPP=false -e VALIDATE_JSCPD=false -v /path/to/local/codebase:/tmp/lint github/super-linter
  1. Push code to your forked repo.
  2. Create pull request.