From 2ca07d517bee8be0cd60fb6d965f4437b0cf9529 Mon Sep 17 00:00:00 2001 From: John Donaldson Date: Tue, 17 Dec 2019 19:47:57 +0000 Subject: [PATCH] Cleaning up CONTRIBUTING.md, clarifying license --- CONTRIBUTING.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9a2b51..a86cc91 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,44 +17,34 @@ Pull requests are the best way to propose changes to the codebase (we use [Gitfl 3. If you've changed APIs, update the documentation. 4. Ensure the test suite passes. 5. Make sure your code lints. -6. Update CHANGELOG.md +6. Update [CHANGELOG.md] 7. Issue that pull request! ## We Deploy to a Variety of Architectures MOTH 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 impracticle to run MOTH anywhere but inside of Docker -## Any contributions you make will be under the TODO Software License -TODO: +## Any contributions you make will be under the MIT Software License In short, when 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. ## Report bugs using Github's [issues](https://github.com/dirtbags/moth/issues) We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! ## Write bug reports with detail, background, and sample code -[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect. **Great Bug Reports** tend to have: - A quick summary and/or background - Steps to reproduce - Be specific! - - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing + - Give sample code if you can. - What you expected would happen - What actually happens - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) -People *love* thorough bug reports. I'm not even kidding. - ## Use a Consistent Coding Style -I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) -* 2 spaces for indentation rather than tabs -* You can try running `npm run lint` for style unification - -### We use Javascript ASI - -## License -By contributing, you agree that your contributions will be licensed under its TODO License. +### Javascript +* We use Javascript ASI ## References -This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) +This document was adapted from the open-source contribution guidelines from [https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62]