2020-01-14 12:08:02 -07:00
# Contributing
2021-04-17 13:06:59 -06:00
## General rules
2020-06-11 08:33:50 -06:00
2020-09-29 10:17:58 -06:00
1. **English only** for issues & pull requests.
2023-10-19 17:03:13 -06:00
2. **Do not edit README.md!** This file is automatically generated. Instead, use:
- [`src/yaml/` ](https://github.com/tycrek/degoogle/tree/master/src/yaml ) for structured data
- [`src/md/` ](https://github.com/tycrek/degoogle/tree/master/src/md ) for regular text
3. Personal opinions will **not** be considered. Instead, provide detailed links as supporting evidence.
2021-08-09 09:49:43 -07:00
4. **Use the templates** when submitting an Issue or Pull Request. Blank Issues/PRs are not allowed.
2020-03-09 12:16:10 -06:00
2021-04-17 13:06:59 -06:00
## How to submit a change
2020-09-29 10:17:58 -06:00
2021-04-17 13:06:59 -06:00
### A: I am not familiar with GitHub or Pull Requests
2023-10-19 17:03:13 -06:00
1. Open a [new Issue ](https://github.com/tycrek/degoogle/issues/new/choose ).
2021-08-09 09:49:43 -07:00
2. Select a template to use. If in doubt, use **Other** .
3. Fill out the information to the best of your ability.
4. When you are finished, click **Submit new issue** .
2021-04-17 13:06:59 -06:00
### B: I have used GitHub Pull Requests
1. Create your Pull Request with your changes.
2023-10-19 17:03:13 -06:00
- Remember to **not** edit README.md!
2021-04-17 13:06:59 -06:00
- As with Issues, fill out the template as best you can.
2023-10-19 17:03:13 -06:00
2. For PR's relating to alternatives, you must also follow the steps above to create an Issue for discussion. Simple PR's that are unrelated to a specific alternative may not require an Issue. If in doubt, create an **Other** Issue.