Update files from best-of template

.github/ISSUE_TEMPLATE/01_suggest-project.md

@@ -1,38 +1,24 @@
 ---
 name: "📦 Suggest a project"
-about: Do you like to suggest a project that hasn't been added yet to this best-of list?
+about: "Do you like to suggest a project that hasn't been added to this best-of list yet?"
 title: 'Add project: '
-labels: add-project
+labels: 'add-project'
 assignees: ''
 
 ---
 
 <!--
-Please make sure that the project was not already added or suggested to this best-of list. You can ensure this by searching the projects.yaml, the Readme, and the issue list.
+Please make sure that the project was not already added or suggested to this best-of list. You can ensure this by searching the projects.yaml, the README.md, and the issue list.
 -->
 
 **Project details:**
 <!-- Please fill out as much of the following information as possible. -->
 
 - Project Name:
 - Github URL:
-- Category:  <!-- Choose one of the existing categories from the Readme or projects.yaml file -->
+- Category:  <!-- Choose one of the existing categories from the README.md or projects.yaml file -->
 - License:
-- Package Managers: <!-- Add the IDs for every package manager that the project is available on. -->
-    - [ ] npm:
-    - [ ] PyPI:
-    - [ ] Conda:
-    - [ ] Dockerhub:
-    - [ ] Gem:
-    - [ ] CRAN:
-    - [ ] Helmhub:
-    - [ ] Maven:
-    - [ ] Go:
-    - [ ] Packagist:
-    - [ ] NuGet:
-    - [ ] Brew:
-    - [ ] Apt:
-    - [ ] ...
+- Package Managers: <!-- Add the IDs for every package manager that the project is available on (e.g. npm, pypi, conda, dockerhub, maven, apt, ...). For example: pypi:tensorflow conda:conda-forge/tensorflow dockerhub:tensorflow/tensorflow -->
 
 **Additional context:**
 

.github/ISSUE_TEMPLATE/02_update-project.md

@@ -2,7 +2,7 @@
 name: "✏️ Update a project"
 about: Do you have changes for a project, e.g. missing package manager, wrong license or category?
 title: 'Update project: '
-labels: update-project
+labels: 'update-project'
 assignees: ''
 
 ---
@@ -14,7 +14,8 @@ Please state the project name that this update is referring to and list all info
 -->
 
 - Project Name:
-- <!--- State all information that needs to be updated. -->
+
+<!--- State all information that needs to be updated. -->
 
 **Additional context:**
 

.github/ISSUE_TEMPLATE/03_update-categories.md

@@ -2,13 +2,13 @@
 name: "🏷 Add or update a category"
 about: Do you like to suggest a new project category or update an existing one?
 title: ''
-labels: categories
+labels: 'category'
 assignees: ''
 
 ---
 
 <!--
-Please select either to add or to update a category:
+Please select either to add or to update a category. Tick of with: [] -> [x]
 -->
 
 - [ ] Add category

.github/ISSUE_TEMPLATE/04_change-configuration.md

@@ -1,8 +1,8 @@
 ---
 name: "⚙️ Change configuration"
-about: Do you have a suggestion for changing the configuration, e.g. allowed licenses or min stars?
+about: Do you have a suggestion for changing the configuration, e.g. allow additional licenses or adjust minimal stars?
 title: ''
-labels: configuration
+labels: 'configuration'
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/05_anything-else.md

@@ -1,14 +1,14 @@
 ---
 name: "\U0001F4AC Anything else?"
-about: For questions or suggestions regarding the metadata collection or markdown generation, please refer to the ml-tooling/best-of-generator repository.
+about: For questions or suggestions regarding the metadata collection or markdown generation, please refer to the best-of-lists/best-of-generator repository.
 title: ''
-labels: ''
+labels: 'question'
 assignees: ''
 
 ---
 
 <!--
-For questions or suggestions regarding the project metadata collection or markdown generation, please refer to the best-of-generator repository: https://github.com/ml-tooling/best-of-generator
+For questions or suggestions regarding the project metadata collection or markdown generation, please refer to the best-of-generator repository: https://github.com/best-of-lists/best-of-generator
 -->
 
 **Describe the issue:**

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,4 +17,4 @@
 tick off all the boxes. [] -> [x] -->
 
 - [ ] I have read the [CONTRIBUTING](https://github.com/ml-tooling/best-of-ml-python/blob/main/CONTRIBUTING.md) guidelines.
-- [ ] I have not modified the `README.md` file. Projects are only supposed to be added or updated within the `projects.yaml` file since the `README.md` file is automatically generated every few days.
+- [ ] I have not modified the `README.md` file. Projects are only supposed to be added or updated within the `projects.yaml` file since the `README.md` file is automatically generated.

CONTRIBUTING.md

@@ -9,7 +9,8 @@ Thanks for your interest in contributing to our project. This page will give you
 2. [Update a project](#update-a-project)
 3. [Improve metadata collection](#improve-metadata-collection)
 4. [Improve markdown generation](#improve-markdown-generation)
-5. [Code of conduct](#code-of-conduct)
+5. [Create your own best-of list](#improve-markdown-generation)
+6. [Code of conduct](#code-of-conduct)
 
 ## Add a project
 
@@ -25,15 +26,14 @@ Before opening an issue or pull request, please ensure that you adhere to the fo
     ```yaml
     - name: Tensorflow
       github_id: tensorflow/tensorflow
-      category: ml-frameworks
       pypi_id: tensorflow
       conda_id: tensorflow
-      docs_url: https://www.tensorflow.org/overview
       labels: ["tensorflow"]
+      category: ml-frameworks
     ```
 - Please create an individual issue or pull request for each project.
 - Please use the following title format for the issue or pull request: `Add project: project-name`.
-- If a project doesn't fit any of the pre-existing categories, it should go under the `Others` category by not assigning any category. You can also suggest a new category via the add or update category template on the [issue page](https://github.com/ml-tooling/best-of-ml-python/issues/new/choose).
+- If a project doesn't fit into any of the pre-existing categories, it should go under the `Others` category by not assigning any category. You can also suggest a new category via the add or update category template on the [issue page](https://github.com/ml-tooling/best-of-ml-python/issues/new/choose).
 
 ## Update a project
 
@@ -56,68 +56,62 @@ Before opening an issue or pull request, please ensure that you adhere to the fo
         <th>Description</th>
     </tr>
     <tr>
-        <td>name</td>
-        <td>Name of the project.</td>
-    </tr>
-    <tr>
-        <td>github_id</td>
-        <td>Github ID of the project based on user or organization  and the repository name (e.g. <code>ml-tooling/best-of-generator</code>).</td>
+        <td><code>name</code></td>
+        <td>Name of the project. This name is required to be unique on the best-of list.</td>
     </tr>
     <tr>
-        <td>category</td>
-        <td>Category that this project is most related to. You can find all available category IDs in the <code>projects.yaml</code> file. The project will be sorted into the <code>Others</code> category if no category is provided.</td>
+        <td><code>github_id</code></td>
+        <td>Github ID of the project based on user or organization and the repository name, e.g. <code>best-of-lists/best-of-generator</code>.</td>
     </tr>
     <tr>
         <td colspan="2"><b>Optional Properties:</b></td>
     </tr>
     <tr>
-        <td>license</td>
-        <td>License of the project. If set, license information from Github or package managers will be overwritten.</td>
-    </tr>
-    <tr>
-        <td>labels</td>
-        <td>List of labels that this project is related to. You can find all available label IDs in the projects.yaml file.</td>
-    </tr>
-    <tr>
-        <td>description</td>
-        <td>Short description of the project. If set, the description from Github or package managers will be overwritten.</td>
+        <td><code>category</code></td>
+        <td>Category that this project is most related to. You can find all available category IDs in the <code>projects.yaml</code> file. The project will be sorted into the <code>Others</code> category if no category is provided.</td>
     </tr>
     <tr>
-        <td>homepage</td>
-        <td>Hompage URL of the project. Only use this property if the project homepage is different from the Github URL.</td>
+        <td><code>labels</code></td>
+        <td>List of labels that this project is related to. You can find all available label IDs in the <code>projects.yaml</code> file.</td>
     </tr>
     <tr>
-        <td>docs_url</td>
-        <td>Documentation URL of the project. Only use this property if the project documentation site is different from the Github URL.</td>
+        <td colspan="2"><b>Supported Package Managers:</b></td>
     </tr>
     <tr>
-        <td colspan="2"><b>Supported Package Managers:</b></td>
+        <td><code>pypi_id</code></td>
+        <td>Project ID on the python package index (<a href="https://pypi.org">PyPi</a>).</td>
     </tr>
     <tr>
-        <td>pypi_id</td>
-        <td>Project ID on the python package index (pypi.org).</td>
+        <td><code>conda_id</code></td>
+        <td>Project ID on the <a href="https://anaconda.org">conda package manager</a>. If the main package is provided on a different channel, prefix the ID with the given channel: e.g. <code>conda-forge/tensorflow</code></td>
     </tr>
     <tr>
-        <td>conda_id</td>
-        <td>Project ID on the conda package manager (anaconda.org). If the main package is provided on a different channel, prefix the ID with the given channel: e.g. <code>conda-forge/tensorflow</code></td>
+        <td><code>npm_id</code></td>
+        <td>Project ID on the Node package manager (<a href="https://www.npmjs.com">npm</a>).</td>
     </tr>
     <tr>
-        <td>npm_id</td>
-        <td>Project ID on the Node package manager (npmjs.com).</td>
+        <td><code>dockerhub_id</code></td>
+        <td>Project ID on the <a href="https://hub.docker.com">Docker Hub container registry</a>. </td>
     </tr>
     <tr>
-        <td>dockerhub_id</td>
-        <td>Project ID on the Dockerhub container registry (hub.docker.com). </td>
+        <td><code>maven_id</code></td>
+        <td>Artifact ID on <a href="https://mvnrepository.com">Maven central</a>, e.g. <code>org.apache.flink:flink-core</code>. </td>
     </tr>
 </table>
 
+Please refer to the [best-of-generator documentation](https://github.com/best-of-lists/best-of-generator#project-properties) for a complete and up-to-date list of supported project properties.
+
 ## Improve metadata collection
 
-If you like to contribute to or share suggestions regarding the project metadata collection, please refer to the [best-of-generator](https://github.com/ml-tooling/best-of-generator) repository.
+If you like to contribute to or share suggestions regarding the project metadata collection, please refer to the [best-of-generator](https://github.com/best-of-lists/best-of-generator) repository.
 
 ## Improve markdown generation
 
-If you like to contribute to or share suggestions regarding the markdown generation, please refer to the [best-of-generator](https://github.com/ml-tooling/best-of-generator) repository.
+If you like to contribute to or share suggestions regarding the markdown generation, please refer to the [best-of-generator](https://github.com/best-of-lists/best-of-generator) repository.
+
+## Create your own best-of list
+
+If you want to create your own best-of list, we strongly recommend to follow [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md). With this guide, it will only take about 3 minutes to get you started. It is already set-up to automatically run the best-of generator via our Github Action and includes other useful template files.
 
 ## Code of Conduct
 

config/footer.md

@@ -16,7 +16,7 @@ Contributions are encouraged and always welcome! If you like to add or update pr
 - Open an issue by selecting one of the provided categories from the [issue page](https://github.com/ml-tooling/best-of-ml-python/issues/new/choose) and fill in the requested information.
 - Modify the [projects.yaml](https://github.com/ml-tooling/best-of-ml-python/blob/main/projects.yaml) with your additions or changes, and submit a pull request. This can also be done directly via the [Github UI](https://github.com/ml-tooling/best-of-ml-python/edit/main/projects.yaml).
 
-If you like to contribute to or share suggestions regarding the project metadata collection or markdown generation, please refer to the [best-of-generator](https://github.com/ml-tooling/best-of-generator) repository.
+If you like to contribute to or share suggestions regarding the project metadata collection or markdown generation, please refer to the [best-of-generator](https://github.com/best-of-lists/best-of-generator) repository. If you like to create your own best-of list, we recommend to follow [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md).
 
 For more information on how to add or update projects, please read the [contribution guidelines](https://github.com/ml-tooling/best-of-ml-python/blob/main/CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/ml-tooling/best-of-ml-python/blob/main/.github/CODE_OF_CONDUCT.md).
 

config/header.md

@@ -17,5 +17,6 @@
     <a href="https://twitter.com/mltooling" title="Follow on Twitter"><img src="https://img.shields.io/twitter/follow/mltooling.svg?style=social&label=Follow"></a>
 </p>
 
+This curated list contains {project_count} awesome open-source projects with a total of {stars_count} stars grouped into {category_count} categories. All projects are ranked by a project-quality score, which is calculated based on various metrics automatically collected from GitHub and different package managers. If you like to add or update projects, feel free to open an [issue](https://github.com/ml-tooling/best-of-ml-python/issues/new/choose), submit a [pull request](https://github.com/ml-tooling/best-of-ml-python/pulls), or directly edit the [projects.yaml](https://github.com/ml-tooling/best-of-ml-python/edit/main/projects.yaml). Contributions are very welcome!
 
-This curated list contains {project_count} awesome open-source projects with a total of {stars_count} stars grouped into {category_count} categories. All projects are ranked by a project-quality score, which is calculated based on various metrics automatically collected from Github and different package managers. If you like to add or update projects, feel free to open an [issue](https://github.com/ml-tooling/best-of-ml-python/issues/new/choose), submit a [pull request](https://github.com/ml-tooling/best-of-ml-python/pulls), or directly edit the [projects.yaml](https://github.com/ml-tooling/best-of-ml-python/edit/main/projects.yaml). Contributions are very welcome!
+> 🧙‍♂️ Create your own best-of list in just 3 minutes with [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md).