Merge pull request #4 from erbesharat/docs/reposeed

[docs]: Add README, usage guide, and reposeed config

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!--
+This form is for bug reports and feature requests ONLY!  
+If you're looking for help check out [our support guidelines](/SUPPORT.md).
+-->
+**Is this a BUG REPORT or FEATURE REQUEST?**:
+bug | feature
+
+**What happened**:
+
+**What you expected to happen**:
+
+**How to reproduce it (as minimally and precisely as possible)**:
+
+**Anything else we need to know?**:
+
+**Environment**:
+- Godocit version:  
+- Others:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+<!--
+Thanks for sending a pull request!  
+If this is your first time, read our [contributing guidelines](/CONTRIBUTING.md).
+-->
+**What this PR does / why we need it**:
+
+<!--
+**Which issue this PR fixes** *(optional - uncomment and add issue)*:
+fixes #0
+-->
+
+**Special notes for your reviewer**:
+
+**Release note**:
+<!--
+Optional one line note for this specific change, that can be used in a release-note or changelog.
+-->
+```release-note
+
+```

.gitlab/issue_templates/Bug.md

@@ -0,0 +1,17 @@
+<!--
+This form is for bug reports and feature requests ONLY!  
+If you're looking for help check out [our support guidelines](/SUPPORT.md).
+-->
+**Bug report**
+
+**What happened**:
+
+**What you expected to happen**:
+
+**How to reproduce it (as minimally and precisely as possible)**:
+
+**Anything else we need to know?**:
+
+**Environment**:
+- Godocit version:  
+- Others:

.gitlab/issue_templates/Feature.md

@@ -0,0 +1,11 @@
+<!--
+This form is for feature requests ONLY!  
+If you're looking for help check out [our support guidelines](/SUPPORT.md).
+-->
+**Feature request**
+
+**What this feature does / why we need it**:
+
+**Which issue this feature fix (if any)**
+
+**Anything else we need to know?**:

.gitlab/merge_request_templates/Merge Request.md

@@ -0,0 +1,20 @@
+<!--
+Thanks for sending a pull request!  
+If this is your first time, read our [contributing guidelines](/CONTRIBUTING.md)
+-->
+**What this PR does / why we need it**:
+
+<!--
+**Which issue this PR fixes** *(optional - uncomment and add issue)*:
+fixes #
+-->
+
+**Special notes for your reviewer**:
+
+**Release note**:
+<!--
+Optional one line note for this specific change, that can be used in a release-note or changelog.
+-->
+```release-note
+
+```

.seed-config.yaml

@@ -0,0 +1,106 @@
+project:
+  name: "Godocit"
+  state: "unstable"
+  image: "https://raw.githubusercontent.com/okkur/actions-godocit/master/media/logo.svg?sanitize=true"
+  website: "https://godocit.okkur.org"
+  oneLiner: "Create documentation needed issues across different repositories"
+  description: |
+    When a PR introduces a new feature that requires documentation, this action
+    can automatically create an issue on your website's repository to add
+    documentation for that new feature.
+  version: "v0.1.0"
+  mainLicense: "apache2"
+  docsLicense: "CCBySa"
+
+vision:
+  type: ""
+  overview: |
+    Provide an automatic flow for keeping track of documentation.
+  items:
+    - 'Works easily by just adding a "documentation needed" label on the PR'
+    - "Create issues on different repositories"
+  concept: "Godocit's core concept is to provide an automatic tool to never miss
+    documentation for new features."
+  aim: "Godocit provides an easy and fast way to create documentation issues for
+    new features and keep track of undocumented features"
+
+readme:
+  usageExample: |
+    For using godocit you first need to create a Github App and install it on your
+    user or organization that has **write** access to the target repository.
+    For more information read the ["Authenticating with GitHub Apps"](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/) page.
+
+    Note: The generated private key for the GitHub Action should be stored in a 
+    secret named `PrivateKey` on the source repository. For more information
+    about secrets, read the [Creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) page.
+
+
+    After creating the app and installing it on your user or organization, write the
+    following config in `.github/workflows/godocit.yml` file in your source repository:
+    ```
+    name: CI
+
+    on: 
+      pull_request:
+        types: [labeled]
+
+    jobs:
+      build:
+        runs-on: ubuntu-latest
+        steps:
+        - name: Create the documentation issues
+          uses: okkur/[email protected]
+          with:
+            targetRepo: 'USER/REPO'
+          env:
+            PRIVATE_KEY: ${{ secrets.PrivateKey }}
+            INSTALLATION_ID: ${{ secrets.InstallationID }}
+
+    ```
+
+    Replace the `targetRepo` input with the target repository's name. 
+    Then after activating the action on the source repository, create the
+    `PrivateKey` and `InstallationID` secrets on the source repository and fill 
+    them with the GitHub App's **Private Key** and **Installation ID**.
+
+    Now that GitHub Action, workflow and the secrets are setup, you can add the
+    "documentation needed" label. Then a job will get
+    activated and creates a "Documentation Needed" issue on the target repository.
+
+contributionLinks:
+  issueTemplate: "/.github/ISSUE_TEMPLATE.md"
+  starterIssues: "https://github.com/okkur/actions-godocit/labels/starter%20issue"
+
+emails:
+  commercialSupport: "[email protected]"
+  security: "[email protected]"
+  coc: "[email protected]"
+
+copyright:
+  owner: "The Godocit authors"
+  year: "2019"
+
+cla:
+  copyrightHolder: "nzt.ventures GmbH"
+  mail: "[email protected]"
+
+maintainers:
+  - name: "Michael Grosser"
+    nick: "stp-ip"
+
+repo:
+  link: "https://godocit.okkur.org/repo"
+  type: "Github"
+
+badges:
+  - image: "https://img.shields.io/badge/state-unstable-blue.svg"
+    alt: "state"
+  - image: "https://img.shields.io/github/release/okkur/actions-godocit.svg"
+    link: "https://godocit.okkur.org/releases"
+    alt: "release"
+  - image: "https://img.shields.io/github/license/okkur/actions-godocit.svg"
+    link: "LICENSE"
+    alt: "license"
+
+reposeed:
+  configVersion: "v1"

CHANGELOG.md

@@ -0,0 +1,40 @@
+<!--
+# v0.2.0
+_2017_
+  - [Downloads for v0.2.0](#downloads-for-v020)
+  - [Changelog since v0.1.0](#changes-since-v010)
+  - [Documentation for v0.2.0](#documentation-for-v020)
+
+## Documentation for v0.2.0
+[Documentation](/tree/v0.2.0/docs)
+
+## Changes since v0.1.0
+
+## Fixes since v0.1.0
+
+---
+
+-->
+
+# v0.1.0
+_2017-01-01_
+  - [Downloads for v0.1.0](#downloads-for-v010)
+  - [Changelog since v0.0.0](#changes-since-v000)
+  - [Documentation for v0.1.0](#documentation-for-v010)
+
+## Downloads for v0.1.0
+
+file | sha1 hash | md5 hash
+--- | --------- | --------
+[file.tar.gz](https://example.com/release/v0.1.0/file.tar.gz) | `1578305efcb3eb8c7964adc535adb2e4b1fe41f6` | `92fcfd07d75ae94bfca36ded722ae7b626091fe4f7e76f6fcbf9f46a2fe3aab6`
+
+## Documentation for v0.1.0
+
+
+
+## Changes since v0.0.0
+  - Feature X
+  - Feature Z
+
+## Fixes since v0.0.0
+  - Fix 123

CLA/CORPORATE_CONTRIBUTOR_LICENSE_AGREEMENT.md

@@ -0,0 +1,29 @@
+# Corporate contributor license agreement
+
+You accept and agree to the following terms and conditions for Your present and future Contributions submitted to nzt.ventures GmbH. Except for the license granted herein to nzt.ventures GmbH and recipients of software distributed by nzt.ventures GmbH, You reserve all right, title, and interest in and to Your Contributions.
+
+1.  Definitions.
+
+	"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with nzt.ventures GmbH. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+	"Contribution" shall mean the code, documentation or other original works of authorship, including any modifications or additions to an existing work, that is submitted by You to nzt.ventures GmbH for inclusion in, or documentation of, any of the products owned or managed by nzt.ventures GmbH (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to nzt.ventures GmbH or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, nzt.ventures GmbH for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+
+2.  Grant of Copyright License.
+
+Subject to the terms and conditions of this Agreement, You hereby grant to nzt.ventures GmbH and to recipients of software distributed by nzt.ventures GmbH a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
+
+3.  Grant of Patent License.
+
+Subject to the terms and conditions of this Agreement, You hereby grant to nzt.ventures GmbH and to recipients of software distributed by nzt.ventures GmbH a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+4.  You represent that You are legally entitled to grant the above license. You represent further that each of Your employees is authorized to submit Contributions on Your behalf, but excluding employees that are designated in writing by You as "Not authorized to submit Contributions on behalf of [name of Your corporation here]." Such designations of exclusion for unauthorized employees are to be submitted via email to [email protected].
+
+5.  You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others).
+
+6.  You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+7.  Should You wish to submit work that is not Your original creation, You may submit it to nzt.ventures GmbH separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
+
+8.  It is Your responsibility to notify nzt.ventures GmbH when any change is required to the list of designated employees excluded from submitting Contributions on Your behalf per Section 4. Such notification should be sent via email to [email protected].
+
+This text is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/) and the original source is the Google Open Source Programs Office.

CLA/INDIVIDUAL_CONTRIBUTOR_LICENSE_AGREEMENT.md

@@ -0,0 +1,25 @@
+# Individual contributor license agreement
+
+You accept and agree to the following terms and conditions for Your present and future Contributions submitted to nzt.ventures GmbH Except for the license granted herein to nzt.ventures GmbH and recipients of software distributed by nzt.ventures GmbH, You reserve all right, title, and interest in and to Your Contributions.
+
+1.  Definitions.
+
+	"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with nzt.ventures GmbH. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+	"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to nzt.ventures GmbH for inclusion in, or documentation of, any of the products owned or managed by nzt.ventures GmbH (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to nzt.ventures GmbH or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, nzt.ventures GmbH for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+
+2.  Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to nzt.ventures GmbH and to recipients of software distributed by nzt.ventures GmbH a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
+
+3.  Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to nzt.ventures GmbH and to recipients of software distributed by nzt.ventures GmbH a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+4.  You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to nzt.ventures GmbH, or that your employer has executed a separate Corporate CLA with nzt.ventures GmbH.
+
+5.  You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
+
+6.  You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+7.  Should You wish to submit work that is not Your original creation, You may submit it to nzt.ventures GmbH separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [insert_name_here]".
+
+8.  You agree to notify nzt.ventures GmbH of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
+
+This text is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/) and the original source is the Google Open Source Programs Office.