Merge pull request #514 from tycrek/contributing-updates

8 months ago · 37b1bed679
parent 31e46fe8ce 0588ca29d3
commit 37b1bed679
11 changed files with 48 additions and 45 deletions
--- a/.github/ISSUE_TEMPLATE/1-new-alternative.yml
+++ b/.github/ISSUE_TEMPLATE/1-new-alternative.yml
@ -19,7 +19,6 @@ body:
      options:
        - label: "**I have read the guidelines in [CONTRIBUTING.md](../blob/master/CONTRIBUTING.md)**"
          required: true
-        - label: Include my name in [CONTRIBUTORS.md](../blob/master/CONTRIBUTORS.md)
        - label: I am affiliated with this alternative
  - type: input
    id: name
@ -32,7 +31,7 @@ body:
    id: section
    attributes:
      label: Section
-      description: Please also include the section you feel it belongs best in
+      description: Also include the section you feel it belongs best in
      multiple: true
      options:
       - Browser extensions
@ -46,7 +45,7 @@ body:
    attributes:
      label: Description
      description: |
-        Please provide a brief description of the alternative,
+        Provide a brief description of the alternative,
        one to 5 sentences which will be displayed along with the name.
    validations:
      required: true
@ -86,7 +85,7 @@ body:
    attributes:
      label: Is this alternative hosted in a country that performs surveillance?
      description: |
-        For more info on 5/9/14 eyes, please check here: https://restoreprivacy.com/5-eyes-9-eyes-14-eyes/
+        For more info on 5/9/14 eyes, visit: https://restoreprivacy.com/5-eyes-9-eyes-14-eyes/
        Usually only one applies, but you may select more than one.
      options:
        - label: 5 Eyes
@ -103,7 +102,7 @@ body:
  - type: dropdown
    id: self-hosting
    attributes:
-      label: Please indicate if self-hosting is possible, not possible, or the only option
+      label: Indicate if self-hosting is possible, not possible, or the only option
      options:
        - Possible
        - Not possible
--- a/.github/ISSUE_TEMPLATE/2-fix-update-alternative.yml
+++ b/.github/ISSUE_TEMPLATE/2-fix-update-alternative.yml
@ -19,7 +19,6 @@ body:
      options:
        - label: "**I have read the guidelines in [CONTRIBUTING.md](../blob/master/CONTRIBUTING.md)**"
          required: true
-        - label: Include my name in [CONTRIBUTORS.md](../blob/master/CONTRIBUTORS.md)
        - label: I am affiliated with this alternative
  - type: input
    id: alternative_name
--- a/.github/ISSUE_TEMPLATE/3-remove-alternative.yml
+++ b/.github/ISSUE_TEMPLATE/3-remove-alternative.yml
@ -18,7 +18,6 @@ body:
      options:
        - label: "**I have read the guidelines in [CONTRIBUTING.md](../blob/master/CONTRIBUTING.md)**"
          required: true
-        - label: Include my name in [CONTRIBUTORS.md](../blob/master/CONTRIBUTORS.md)
        - label: I am affiliated with this alternative
  - type: input
    id: alternative_name
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@ -1,15 +1,13 @@
 <!-- If your Pull Request is related to an alternative, make sure there is a corresponding Issue for discussion. -->

-| Checklist |   |
-| --------- | - |
-| **I have read the guidelines in [CONTRIBUTING.md]**   | yes/no |
-| Include my name in [CONTRIBUTORS.md]                  | yes/no |
-| I am affiliated with this alternative (if applicable) | yes/no |
+### Checklist

+- __I have read the guidelines in [CONTRIBUTING.md]__: yes/no
+- __I am affiliated with this alternative (if applicable)__: yes/no

 ### Details
 <!-- Optional if details exist in a linked Issue. If that is the case, link to the Issue here. -->


+
 [CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
-[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@ -3,7 +3,7 @@ on:
  push:
    branches:
      - master
-    paths:
+    paths: # Only build if these files were modified
      - yaml/*.yml
      - md/*.md
      - _build.js
@ -14,6 +14,7 @@ jobs:
    steps:
    - uses: actions/checkout@v4
      with:
+        # GH_PAT must be a PAT for repo owner
        token: ${{ secrets.GH_PAT }}
    - uses: actions/setup-node@v3
      with:
@ -21,6 +22,7 @@ jobs:
    - name: Build README
      run: npm i && node _build.js
    - name: Commit & Push
+      # GH_NAME/GH_EMAIL can be any collaborator account with Force Push access
      run: |
        git add README.md
        git config --local user.name "${{ vars.GH_NAME }}"
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -1,21 +1,19 @@
 # Contributing

-###### Last revised: August 9th, 2021
-
-###### Templates revised: August 9th, 2021
-
 ## General rules

 1. **English only** for issues & pull requests.
-2. **Do not edit `README.md`!** This file is automatically generated.
-3. Personal opinions will **not** be considered when adding or removing an alternative. Instead, provide links to articles with details.
+2. **Do not edit README.md!** This file is automatically generated. Instead, use:
+   - [`yaml/`](https://github.com/tycrek/degoogle/tree/master/yaml) for structured data
+   - [`md/`](https://github.com/tycrek/degoogle/tree/master/md) for regular text
+3. Personal opinions will **not** be considered. Instead, provide detailed links as supporting evidence.
 4. **Use the templates** when submitting an Issue or Pull Request. Blank Issues/PRs are not allowed.

 ## How to submit a change

 ### A: I am not familiar with GitHub or Pull Requests

-1. Open a [new Issue].
+1. Open a [new Issue](https://github.com/tycrek/degoogle/issues/new/choose).
 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**.
@ -23,13 +21,6 @@
 ### B: I have used GitHub Pull Requests

 1. Create your Pull Request with your changes.
-   - Remember to **not** edit `README.md`!
+   - Remember to **not** edit README.md!
   - As with Issues, fill out the template as best you can.
-2. For PR's relating to alternatives, please follow the steps above to also 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.
-
-## I contributed but I am not in the list (or) I do not want to be in the list anymore
-
-If you submitted a change that made it into the guide but don't have your Reddit or GitHub username in the [CONTRIBUTORS.md] list, open an issue or pull request so I can fix it. Alternatively, if your username is on the list and you do *not* want it there, feel free to request this as well.
-
-[new Issue]: https://github.com/tycrek/degoogle/issues/new/choose
-[CONTRIBUTORS.md]: https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md
+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.
--- a/MIRRORS.md
+++ b/MIRRORS.md
@ -1,8 +1,6 @@
 # Degoogle Mirrors

-If you host a mirror, let me know through an Issue or PR so it can be added to the community mirrors list. It would be prefered if your mirror is auto-updating.
-
-Official mirrors are the main sources and are maintained by me (@tycrek). Community mirrors are other Git instances run by other users that I can't control.
+Official mirrors are managed by me ([@tycrek](https://github.com/tycrek)). Community mirrors are Git instances run by other users that I can't control (they may be out of date as well).

 ## Official mirrors

@ -13,7 +11,7 @@ Official mirrors are the main sources and are maintained by me (@tycrek). Commun

 - [Gitea mirror](https://git.mirkodi.eu/mirk0dex/degoogle) from [@mirk0dex (Gitea)](https://git.mirkodi.eu/mirk0dex)

-## Non-english mirrors
+### Non-english mirrors

 - [Turkish/Türk](https://github.com/melikechan/degoogle-turkish) from [@melikechan](https://github.com/melikechan)
 - [Italian/Italiano](https://gitea.it/devol/degooglizzazione) from [@devol (Gitea)](https://gitea.it/devol)
--- a/md/_contributing.md
+++ b/md/_contributing.md
@ -1,12 +1,11 @@
 # Contributing

-If you want to help out with the project, here are some ideas (submit **Issues** & **Pull Requests** on the [GitHub page](https://github.com/tycrek/degoogle)):
+If you want to help out with the project, here are some ideas:

- **iOS app alternatives!** I don't have an iOS device to find alternatives with. I would highly appreciate any help with this.
- Clean up/improve the Markdown.
+- Find more iOS app alternatives
 - Provide more information on services with little info or where *help requested!* is shown.
 - Suggest new services or provide info for removing existing services.
- Host a mirror or clone the [repo](https://github.com/tycrek/degoogle). If you host a mirror, let me know and I can add it to the mirrors list.
+- Host a mirror or fork the repo. If you host a mirror, let me know and I can add it to the mirrors list.
 - Anything else relating to any part of this guide, whether it's Google related or not.

-When contributing, **please follow the rules outlined in [CONTRIBUTING.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTING.md)**.
+When contributing, **follow the rules outlined in [CONTRIBUTING.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTING.md)**.
--- a/md/_header.md
+++ b/md/_header.md
@ -1,17 +1,35 @@



+[//]: # ( !!! DO NOT EDIT THIS FILE !!! )



+[//]: # ( !!! DO NOT EDIT THIS FILE !!! )


-[//]: # (NOTE: Please do NOT directly edit this file! Instead, edit)
-[//]: # (either degoogle.yml or any Markdown file in the md/ directory)

+[//]: # ( !!! DO NOT EDIT THIS FILE !!! )



+[//]: # ( !!! DO NOT EDIT THIS FILE !!! )
+
+
+
+[//]: # ( !!! DO NOT EDIT THIS FILE !!! )
+
+
+
+[//]: # ( !!! DO NOT EDIT THIS FILE !!! )
+
+
+
+[//]: # ( !!! DO NOT EDIT THIS FILE !!! )
+
+
+
+[//]: # ( !!! DO NOT EDIT THIS FILE !!! )



--- a/md/_license.md
+++ b/md/_license.md
@ -10,6 +10,6 @@ This project is licensed under the **Creative Commons Attribution-ShareAlike 4.0
  - **Attribution:** You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
  - **ShareAlike:** If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
  
-For a full legal text of the license, please visit [Creative Commons Attribution-ShareAlike 4.0 International License][CC-BY-SA 4.0].
+For a full legal text of the license, visit [Creative Commons Attribution-ShareAlike 4.0 International License][CC-BY-SA 4.0].

 [CC-BY-SA 4.0]: https://creativecommons.org/licenses/by-sa/4.0/
--- a/yaml/degoogle.yml
+++ b/yaml/degoogle.yml
@ -64,7 +64,7 @@ web based products:
      eyes: null
      text: >
        Decentralized Google. A web 3 alternative for the Google search engine. In Beta testing mode.
-        Uses IPFS and Tendermint consensus for security and economic incentives. Please see their
+        Uses IPFS and Tendermint consensus for security and economic incentives. Visit their
        [ELI-5 FAQ](https://github.com/cybercongress/congress/blob/master/ecosystem/ELI-5%20FAQ.md)
        for more info.
    - name: Infinity Search
@ -811,7 +811,7 @@ web based products:
      text: >
        One of the top privacy-focused email providers. Servers are in Switzerland in an underground
        guarded bunker that they claim can "survive a nuclear attack".
-        **Privacy note:** Please see [Issue \#258](https://github.com/tycrek/degoogle/issues/258) for
+        **Privacy note:** Visit [Issue \#258](https://github.com/tycrek/degoogle/issues/258) for
        info on ProtonMail privacy & integrity concerns.
    - name: Tutanota
      url: https://tutanota.com/
@ -1115,7 +1115,7 @@ operating systems:
          You'll either need a rooted device with an unlocked bootloader, or a specific device
          depending on which OS you like.
        - You can use [Anarchy-Droid](https://anarchy-droid.com) to install a new operating system on many Android devices.
-        - Please see [Issue \#55](https://github.com/tycrek/degoogle/issues/55) for details on /e/.
+        - Visit [Issue \#55](https://github.com/tycrek/degoogle/issues/55) for details on /e/.
        - You can use [Plexus](https://plexus.techlore.tech/) to check android app compatibility on degoogled Android operating systems.
    - name: Ubuntu Touch
      url: https://ubuntu-touch.io/