Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 1.97 KB
Raw

Contributing to Docksal

Thanks for your interest in contributing to Docksal!

There are many ways you can help the project:

Report issues

First search the issue queue. Others may have experienced the same or a similar issue and have already found a solution or a workaround.

File a new issue if your problem looks to be brand new.

When reporting a functionality related issue, please provide diagnostics information from fin sysinfo. We aim to provide cross-platform support and need to know what's under the hood in your particular case.

Listing detailed steps to reproduce an issue will also help us understand the problem better and fix it faster.

Contribute code

We are sticking with GitHub Flow as our git workflow.

  • develop - development branch, all PRs should be submitted against it
  • master - main stable branch, matches the latest release at all times
  • feature/feature-name - isolated/experimental feature development happens here

To contribute to the project:

  • Fork the repo
  • Create a feature branch (optional)
  • Commit code with meaningful commit messages
  • Create a pull request against develop
  • Discuss the PR with the maintainers, update it as necessary
  • Once approved the PR will be merged

Each PR goes through automated tests on Travis CI. If your PR does not pass the tests, you either have to fix the code or fix the test.

Provide community support

We have a room on Gitter where questions can be asked and answered Gitter

If you have experience with Docksal and Docker, please stick around in the room to help others.