chore: Add documentation

Closes #15
deuzu · Apr 2, 2021 · d74be60 · d74be60
1 parent c7e3c40
commit d74be60
Show file tree

Hide file tree

Showing 4 changed files with 155 additions and 21 deletions.
diff --git a/.github/CONTRIBUTING.MD b/.github/CONTRIBUTING.MD
@@ -0,0 +1,47 @@
+# Contributing to Github Democrat Action
+
+## Commit messages
+
+In order to keep commits history clear and descriptive, we follow very precise rules over how our Git commit messages must be formatted. This specification is inspired by the [AngularJS commit message format](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+Each commit message consists of a header, a body, and a footer.
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+### Type
+
+Must be one of the following:
+- feat: A new feature
+- fix: A bug fix
+- docs: Documentation only changes
+- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- refactor: A code change that neither fixes a bug nor adds a feature
+- perf: A code change that improves performance
+- test: Adding missing or correcting existing tests
+- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
+
+### Scope
+
+The scope could be anything specifying place of the commit change.
+
+### Body (optionnal)
+
+Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+
+The footer should contain any information about Breaking Changes and is also the place to reference related issues.
+
+Breaking Changes, if any, must be indicated in the footer and should start with `BREAKING CHANGE: `.
+References should start with either `Closes`, `Fixes` or `Relates` then a space, a `#` and the reference's id.
+
+```
+BREAKING CHANGE: doing that change the output of this
+Closes #42
+```
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -6,18 +6,13 @@ on:
       - main
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - run: |
-          npm install
-      - run: |
-          npm run all
-  # test:
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v2
-  #     - uses: ./
-  #       with:
-  #         github-token: ${{ secrets.GITHUB_TOKEN }}
+      - run: npm install
+      - run: npm run format-check
+      - run: npm run lint
+      - run: npm run test
+      - run: npm run build
+      - run: npm run package
diff --git a/README.md b/README.md
@@ -1 +1,87 @@
-# Github Democrat Action
+<br />
+<p align="center">
+  <!-- <a href="#">
+    <img src="./logo.png" alt="Logo" width="80" height="80">
+  </a> -->
+
+  <h3 align="center">Github Democrat Action</h3>
+
+  <p align="center">
+    Enforce democracy on a repository by merging pull requests by voting score.
+    <br />
+    <a href="https://github.com/deuzu/github-democrat-action/"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/deuzu/github-democrat-action/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/deuzu/github-democrat-action/issues">Request Feature</a>
+    ·
+    <a href="https://github.com/deuzu/github-democrat-action/pulls">Send a Pull Request</a>
+  </p>
+</p>
+
+## Table of Contents
+
+* [About the Project](#about-the-project)
+  * [Built With](#built-with)
+* [Getting Started](#getting-started)
+  * [Installation](#installation)
+* [Roadmap](#roadmap)
+* [Contributing](#contributing)
+* [License](#license)
+* [Contact](#contact)
+* [Acknowledgements](#acknowledgements)
+
+## About The Project
+
+### Built With
+
+* [Node](https://nodejs.org)
+* [Github actions](https://github.com/features/actions)
+* [TypeScript](https://www.typescriptlang.org/)
+
+## Getting Started
+
+### Installation
+
+Create a new workflow in `.github/workflows/democracy-enforcer.yaml`.
+
+```yaml
+name: 'democracy-enforcer'
+
+on:
+  schedule:
+    - cron: '*/30 * * * *'
+
+jobs:
+  enforce-democracy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: deuzu/github-democrat-action
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## Roadmap
+
+See the [open issues](https://github.com/deuzu/github-democrat-action/issues) for a list of proposed features (and known issues).
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **extremely appreciated**.  
+Please read [those guidelines](./.github/CONTRIBUTING.md) before contributing to this repository.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feat-amazing-feature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feat-amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+[MIT](./LICENSE)
+
+## Contact
+
+## Acknowledgements
diff --git a/action.yml b/action.yml
@@ -1,11 +1,17 @@
-name: 'Your name here'
-description: 'Provide a description here'
-author: 'Your name or organization here'
+name: Democracy Enforcer
+description: Enforce democracy on a repository by merging pull requests by voting score.
+author: deuzu
+
+branding:
+  icon: alert-octagon
+  color: green
+
 inputs:
   github-token:
-    required: true
-    description: 'input description here'
-    default: 'default value if applicable'
+    required: false
+    description: The Github token that give permission on the repository.
+    default: '${{ secret.GITHUB_TOKEN }}'
+
 runs:
-  using: 'node12'
-  main: 'dist/index.js'
+  using: node12
+  main: dist/index.js