Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

46 lines (37 loc) · 2.03 KB

Contributing to Baronial

This is a piece of Free Software, and is licensed to you under the GNU Public License v3. If this is your first time working on or with Free Software, welcome! While there are more details, Free Software basically means that you have the following rights:

  1. You may modify this software to suit your needs. If you do modify it, please indicate that you have done so.
  2. This software can be redistributed to whomever you would like, on the condition that you only charge for the medium of transfer, or your work to redistribute it. You are not allowed to charge for the product itself, or any derived works. For example, if you give someone a USB drive with this software, you can charge them for the drive, but not this product.

Setting up your machine

Regardless of the operating system you're using, you'll need the following tools to contribute back to Baronial:

  1. The Go Programming Language, version 1.12 or higher, for compilation.
  2. Git, for source control.
  3. A text editor/IDE of your choice. Some popular options for working with Go include:
  4. Perl 5, for executing platform independent build scripts.
  5. golint, for style conformance.

Optionally, you may also want to install:

  • docker, for testing and building Linux packages locally, even on Mac and Windows.

Running the Tests

Tests are important! Make sure when you modify this program, that all of the tests execute without failure. This is is always true, but will be strictly enforced when considering accepting Pull Requests. If you're making a contribution, please make sure to add tests of your own.

Unix-like Machines:

make lint
make test

Windows Machines:

go fmt ./...
go test ./...
go vet ./...
golint ./...