CONTRIBUTING.md

Contributing to werf

werf is an Open Source project, and we are thrilled to develop and improve it in collaboration with the community.

Feedback

The first thing we recommend is to check the existing issues, discussion threads, and documentation - there may already be a discussion or solution on your topic. If not, choose the appropriate way to address the issue on the new issue form.

Contributing code

1. Fork the project.

2. Clone the project:

   git clone https://github.com/[GITHUB_USERNAME]/werf

3. Prepare an environment. To build and run werf locally, you'll need to at least have the following installed:

   • Git 2.18.0+
   • Go 1.11.4+
   • Docker
   • go-task (build tool to run common workflows)
   • ginkgo (testing framework required to run tests)

4. Make changes.

5. Build werf:

   task build # The built werf binary will be available in the bin directory.

6. Do manual testing.

7. Run tests:

   task test:unit
   task test:integration
   task test:e2e

8. Format and lint your code:

   task format lint

9. Commit changes:

   • Follow The Conventional Commits specification.
   • Sign off every commit you contributed as an acknowledgment of the DCO.

10. Push commits.

11. Create a pull request.

Coding Conventions

• Effective Go.
• Go's commenting conventions.

Improving the documentation

The documentation is made with Jekyll and contained within ./docs. See the docs DEVELOPMENT.md for information about developing process.