moth

CONTRIBUTING.md

 1# Contributing to MOTH
 2We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
 3
 4- Reporting a bug
 5- Discussing the current state of the code
 6- Submitting a fix
 7- Proposing new features
 8
 9## We Develop with Github
10We use github to host code, to track issues and feature requests, as well as accept pull requests.
11
12## We Use the Feature Branch Workflow
13
14We use the [Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow).
15
16Pull requests are the best way to propose changes to the codebase. 
17We actively welcome your pull requests:
18
191. Fork the repo. Optionally create a branch from `main`.
202. If you've changed code, modify tests that fail on the old code, and pass on the new code.
213. If you've changed APIs, update the documentation.
224. Ensure the test suite passes.
235. Make sure your code lints.
246. Update [CHANGELOG.md](CHANGELOG.md)
257. Issue that pull request!
26
27## We Deploy to a Variety of Architectures
28MOTH is most often deployed using Docker, but we strive to ensure that it can easily be run outside of a Docker environment. Please ensure that and changes will not break or substantially alter Dockerized deployments and that, conversely, changes will not so substantially tie MOTH to Docker or particular Docker deployment that it becomes impractical to run MOTH anywhere but inside of Docker
29
30## Any contributions you make will be under the MIT Software License
31When you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
32
33## Report bugs using Github's [issues](https://github.com/dirtbags/moth/issues)
34We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/dirtbags/moth/issues/new); it's that easy!
35
36## Write bug reports with detail, background, and sample code
37
38**Great Bug Reports** tend to have:
39
40- A quick summary and/or background
41- Steps to reproduce
42  - Be specific!
43  - Give sample code if you can.
44- What you expected would happen
45- What actually happens
46- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
47
48## Use a Consistent Coding Style
49
50### Go
51* Run it through `gofmt`
52
53### Javascript
54* We use Javascript ASI
55
56## References
57This document was adapted from the open-source contribution guidelines from [https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62]