Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.77 KB

CONTRIBUTORS-GUIDE.md

File metadata and controls

36 lines (25 loc) · 1.77 KB
Raw

Contributing to the Split Synchronizer

Split Synchronizer is an open source project and we welcome feedback and contribution. The information below describes how to build the project with your changes, run the tests, and send the Pull Request(PR).

Development

Development process

  1. Fork the repository and create a topic branch from development branch. Please use a descriptive name for your branch.
  2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like "fix bug".
  3. Make sure to add tests for both positive and negative cases.
  4. Run the linter script of the project and fix any issues you find.
  5. Run the build script and make sure it runs with no errors.
  6. Run all tests and make sure there are no failures.
  7. git push your changes to GitHub within your topic branch.
  8. Open a Pull Request(PR) from your forked repo and into the development branch of the original repository.
  9. When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
  10. Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into development.
  11. Keep an eye out for any feedback or comments from Split's SDK team.

Building the SDK

Usage with go

If you're just trying to run the app, run dep ensure`` on the root of the project. Then, execute go run main.go`

Docker

If you want to build a Docker Image, you need to execute the following command at root folder: docker build -t splitsoftware/split-synchronizer:X.X.X .

Running tests

You can use go test ./.. in root directory for running the tests.

Contact

If you have any other questions or need to contact us directly in a private manner send us a note at [email protected].