updated docs
This commit is contained in:
parent
bc1f17f5af
commit
4e9a81bc33
4 changed files with 67 additions and 30 deletions
|
@ -14,21 +14,21 @@ appearance, race, religion, or sexual identity and orientation.
|
||||||
Examples of behavior that contributes to creating a positive environment
|
Examples of behavior that contributes to creating a positive environment
|
||||||
include:
|
include:
|
||||||
|
|
||||||
* Using welcoming and inclusive language
|
- Using welcoming and inclusive language
|
||||||
* Being respectful of differing viewpoints and experiences
|
- Being respectful of differing viewpoints and experiences
|
||||||
* Gracefully accepting constructive criticism
|
- Gracefully accepting constructive criticism
|
||||||
* Focusing on what is best for the community
|
- Focusing on what is best for the community
|
||||||
* Showing empathy towards other community members
|
- Showing empathy towards other community members
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
- The use of sexualized language or imagery and unwelcome sexual attention or
|
||||||
advances
|
advances
|
||||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
* Public or private harassment
|
- Public or private harassment
|
||||||
* Publishing others' private information, such as a physical or electronic
|
- Publishing others' private information, such as a physical or electronic
|
||||||
address, without explicit permission
|
address, without explicit permission
|
||||||
* Other conduct which could reasonably be considered inappropriate in a
|
- Other conduct which could reasonably be considered inappropriate in a
|
||||||
professional setting
|
professional setting
|
||||||
|
|
||||||
## Our Responsibilities
|
## Our Responsibilities
|
||||||
|
@ -68,9 +68,9 @@ members of the project's leadership.
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see
|
For answers to common questions about this code of conduct, see
|
||||||
https://www.contributor-covenant.org/faq
|
<https://www.contributor-covenant.org/faq>
|
||||||
|
|
23
CONTRIBUTING.md
Normal file
23
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
# How to contribute
|
||||||
|
|
||||||
|
:+1::tada: First off, thanks for taking the time to contribute! :+1::tada:
|
||||||
|
|
||||||
|
Here are some important resources:
|
||||||
|
|
||||||
|
- Our [roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) will tell you the future of EnRecipes
|
||||||
|
- You can help [translate](https://github.com/vishnuraghavb/EnRecipes/projects/2) EnRecipes in your native language(not limited to those existing in the `To do`)
|
||||||
|
- Bugs, suggestions or feedback? You can [create an issue here](https://github.com/vishnuraghavb/EnRecipes/issues) or [join the Telegram group](http://t.me/enrecipes)(quicker replies) to make the app better.
|
||||||
|
|
||||||
|
### Instruction for translators
|
||||||
|
|
||||||
|
1. Fork this repository and head to the `app/i18n` folder.
|
||||||
|
2. Create a new JSON file or duplicate any existing file and start translating its values.
|
||||||
|
3. The filenames should be based on this [gist](https://gist.github.com/vishnuraghavb/bf27b068acc35e331adfba66d18e2094).
|
||||||
|
4. Once done, create a new pull request.
|
||||||
|
|
||||||
|
#### Don't know what fork means? No issues.
|
||||||
|
|
||||||
|
1. Just [download the JSON file](https://raw.githubusercontent.com/vishnuraghavb/EnRecipes/main/app/i18n/en.default.json) and start translating its value(right side part after the colon":").
|
||||||
|
2. Once done, share the file to the [EnRecipes Telegram group](http://t.me/enrecipes) or email it to apps@vishnuraghav.com for verification.
|
||||||
|
|
||||||
|
If everything looks good, your translations will be included in the next update and you'll be added to the contributors list for your work.
|
26
PRIVACY.md
Normal file
26
PRIVACY.md
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
# Privacy Policy
|
||||||
|
Vishnu Raghav B built the app EnRecipes as an open source app for use as is.
|
||||||
|
|
||||||
|
|
||||||
|
## Your Privacy
|
||||||
|
I take your privacy seriously! That's why this app does NOT collect or share any personal information.
|
||||||
|
|
||||||
|
The app also does NOT use third party services that collect information used to identify you.
|
||||||
|
|
||||||
|
|
||||||
|
## Links To Third Party Websites
|
||||||
|
The app may contain links to other sites. If you click on a third-party link, you will be directed to that site. Please aware that I am not responsible for the privacy policies on these websites. These sites are not subject to this privacy policy, and you should check their individual privacy policies.
|
||||||
|
|
||||||
|
|
||||||
|
## Changes To This Privacy Policy
|
||||||
|
I reserve the right to modify this privacy policy at any time but only in a way not affecting your privacy. Thus, you are advised to review this page periodically. I will notify you of any changes by posting the new privacy policy on this page. I will also change the “Last Updated” date at the end of this privacy policy. Any changes I make to the privacy policy are effective as of this Last Updated date and replace any prior privacy policies.
|
||||||
|
|
||||||
|
If I make any material changes to this privacy policy, I will notify you by placing a prominent notice on my app.
|
||||||
|
|
||||||
|
|
||||||
|
## Contact Information
|
||||||
|
For any questions, suggestions or concerns regarding my privacy policy, please send me an email to apps@vishnuraghav.com.
|
||||||
|
|
||||||
|
Last Updated: 14 December 2020
|
||||||
|
|
||||||
|
[Template source](https://gist.github.com/G00fY2/584cf4169a9a46b217c831a56b5da6cb)
|
18
README.md
18
README.md
|
@ -42,7 +42,7 @@ You can get the latest release [here](https://github.com/vishnuraghavb/EnRecipes
|
||||||
|
|
||||||
## Having issues, suggestions and feedback?
|
## Having issues, suggestions and feedback?
|
||||||
|
|
||||||
You can add an issue [here](https://github.com/vishnuraghavb/EnRecipes/issues) or [join the Telegram group](http://t.me/enrecipes)(quicker replies)
|
You can [create an issue here](https://github.com/vishnuraghavb/EnRecipes/issues) or [join the Telegram group](http://t.me/enrecipes)(quicker replies)
|
||||||
|
|
||||||
## Future
|
## Future
|
||||||
|
|
||||||
|
@ -54,21 +54,9 @@ You can add an issue [here](https://github.com/vishnuraghavb/EnRecipes/issues) o
|
||||||
- [mondstern](https://codeberg.org/mondstern) (Translator)
|
- [mondstern](https://codeberg.org/mondstern) (Translator)
|
||||||
- [epicalxyz](https://github.com/epicalxyz) (Translator)
|
- [epicalxyz](https://github.com/epicalxyz) (Translator)
|
||||||
|
|
||||||
### Instruction for translators
|
### Want to contribute?
|
||||||
|
|
||||||
You can contribute by translating EnRecipes in your native language.
|
Please read the [CONTRIBUTING.md](https://github.com/vishnuraghavb/EnRecipes/blob/main/CONTRIBUTING.md)
|
||||||
|
|
||||||
1. Fork this repository and head to the `app/i18n` folder.
|
|
||||||
2. Create a new JSON file or duplicate any existing file and start translating its values.
|
|
||||||
3. The filenames should be based on this [gist](https://gist.github.com/vishnuraghavb/bf27b068acc35e331adfba66d18e2094).
|
|
||||||
4. Once done, create a new pull request.
|
|
||||||
|
|
||||||
#### Don't know what fork means? No issues.
|
|
||||||
|
|
||||||
1. Just [download the JSON file](https://raw.githubusercontent.com/vishnuraghavb/EnRecipes/main/app/i18n/en.default.json) and start translating its value(right side part after the colon":").
|
|
||||||
2. Once done, share the file to the [EnRecipes Telegram group](http://t.me/enrecipes) for verification.
|
|
||||||
|
|
||||||
If everything looks good, your translations will be included in the next update and you'll be added to the contributors list for your work.
|
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue