From f8ea8fe3b7adbebd2d74ab1051a54e65958d54cd Mon Sep 17 00:00:00 2001 From: Hayden Date: Sun, 3 Jan 2021 13:24:31 -0900 Subject: [PATCH] updated docs --- dev/dev-notes.md | 2 +- docs/docs/1.9 - release-notes.md | 11 ++++++++ docs/docs/2.1 - Contributions.md | 46 ++++++++++++++++++++++++++++++++ 3 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 docs/docs/2.1 - Contributions.md diff --git a/dev/dev-notes.md b/dev/dev-notes.md index 0becce626fce..9ef17a3620a3 100644 --- a/dev/dev-notes.md +++ b/dev/dev-notes.md @@ -14,7 +14,7 @@ Backend - [ ] Export Markdown on Auto backups # Draft Changelog -## v0.1.0 +## v0.0.1 General - Updated Favicon diff --git a/docs/docs/1.9 - release-notes.md b/docs/docs/1.9 - release-notes.md index 7264f9d8185d..9e19854fb464 100644 --- a/docs/docs/1.9 - release-notes.md +++ b/docs/docs/1.9 - release-notes.md @@ -1,5 +1,16 @@ # Release Notes +## v0.0.1 - Pre-release Patch +General +- Updated Favicon +- Renamed Frontend Window +- Added Debug folder to dump scraper data prior to processing. + +Recipes +- Added user feedback on bad URL +- Better backend data validation for updating recipes, avoid small syntax errors corrupting database entry. [Issue #8](https://github.com/hay-kot/mealie/issues/8) +- Fixed spacing issue while editing new recipes in JSON + ## v0.0.0 - Initial Pre-release The initial pre-release. It should be semi-functional but does not include a lot of user feedback You may notice errors that have no user feedback and have no idea what went wrong. diff --git a/docs/docs/2.1 - Contributions.md b/docs/docs/2.1 - Contributions.md new file mode 100644 index 000000000000..8b6db8a98ce0 --- /dev/null +++ b/docs/docs/2.1 - Contributions.md @@ -0,0 +1,46 @@ +# Contributing to Mealie +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a maintainer + +## We Develop with Github +We use github to host code, to track issues and feature requests, as well as accept pull requests. + +## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: + +1. Fork the repo and create your branch from `master`. +2. If you've changed APIs, update the documentation. +3. Make sure your code lints. +4. Issue that pull request! +5. If you make changes to the dev/0.1.0 branch reflect those changes in the dev/dev-notes.md to keep track of changes. + +## 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/briandk/transcriptase-atom/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 +**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 +- 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. + + +## License +By contributing, you agree that your contributions will be licensed under its MIT License. + +## 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) \ No newline at end of file