docs: Complete Documentation Rewrite (#2108)

Co-authored-by: huangyuning <huangyuning@vv.cn>
Co-authored-by: aLeSangK <le.sang@access-company.com>
Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>
Co-authored-by: Dhruv Goel <dhruv.goel92@gmail.com>
Co-authored-by: Matheus Mello <mat.mello93@gmail.com>
Co-authored-by: Pietro Coelho <pietrofxq@gmail.com>
Co-authored-by: Old_dream <yuninghuang8@gmail.com>

.browserslistrc

@@ -0,0 +1,3 @@
+> 1%
+not IE 11
+last 2 versions

.eslintignore

@@ -0,0 +1,4 @@
+node_modules/
+dist/ 
+lib/ 
+.*

.eslintrc.json

@@ -0,0 +1,34 @@
+{
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "extends": ["jason/react", "prettier"],
+  "plugins": ["react-hooks"],
+  "env": {
+    "node": true,
+    "browser": true,
+    "es6": true
+  },
+  "rules": {
+    "global-require": "off",
+    "no-console": [
+      "error",
+      {
+        "allow": ["warn", "error", "info"]
+      }
+    ],
+    "no-unused-vars": [
+      "error",
+      {
+        "vars": "all",
+        "args": "after-used",
+        "varsIgnorePattern": "^_",
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn"
+  }
+}

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,50 @@
+name: "\U0001F680 New feature proposal"
+description: Propose a new feature to be added to Big Calendar
+labels: ['feature request']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your interest in the project and taking the time to fill out this feature request!
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Clear and concise description of the problem
+      description: As a developer using Big Calendar I want [goal / wish] so that [benefit]
+    validations:
+      required: true
+  - type: textarea
+    id: suggested-solution
+    attributes:
+      label: Suggested solution
+      description: 'In module [xy] we could provide following implementation...'
+    validations:
+      required: true
+  - type: textarea
+    id: alternative
+    attributes:
+      label: Alternative
+      description: Clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Any other context or screenshots about the feature request here.
+  - type: checkboxes
+    id: checkboxes
+    attributes:
+      label: Validations
+      description: Before submitting the issue, please make sure you do the following
+      options:
+        - label: Read the [docs](http://jquense.github.io/react-big-calendar/examples/index.html).
+          required: true
+        - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
+          required: true
+  - type: checkboxes
+    id: pr
+    attributes:
+      label: Would you like to open a PR for this feature?
+      description: Before starting to work on PR it is recommended to get maintainers approval. The fastest, and most appreciated way to have feature included is to create a pull request with working, tested code and we will help get it merged. Don't be scared to open a pull request that isn't completed and ask for input. We're happy to give direction!
+      options:
+        - label: I'm willing to open a PR
+          required: false

.github/ISSUE_TEMPLATE/new-issue.yml

@@ -0,0 +1,89 @@
+name: 🐞 Big Calendar Issue
+description: Create a report for Big Calendar
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    id: qa
+    attributes:
+      label: Check that this is really a bug
+      description: For Q&A open go to [StackOverflow](https://stackoverflow.com/)
+      options:
+        - label: I confirm
+          required: true
+  - type: input
+    id: reproduction
+    attributes:
+      label: Reproduction link
+      description: Please provide a link to a repo that can reproduce the problem you ran into. You can fork our [Issue Template](https://codesandbox.io/s/react-big-calendar-example-v9wdyd) in codesandbox to get start. A reproduction is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "missing demo" label. If no reproduction is provided after 3 days, it will be auto-closed.
+      placeholder: 'https://codesandbox.io/..'
+    validations:
+      required: true
+  - type: textarea
+    id: descr
+    attributes:
+      label: Bug description
+      description: A clear and concise description of what the bug is
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you're experiencing
+    validations:
+      required: false
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: input
+    id: bigcalendar
+    attributes:
+      label: react-big-calendar version
+      description: Exact release version or commit hash
+      placeholder: e.g 0.39.3
+    validations:
+      required: true
+  - type: input
+    id: reactversion
+    attributes:
+      label: React version
+      description: Exact release version or commit hash
+      placeholder: e.g 17.0.2
+    validations:
+      required: true
+  - type: input
+    id: browser
+    attributes:
+      label: Platform/Target and Browser Versions
+      description: Platform client you are targeting such as macOS, Windows, Cordova, iOS, Android, Chrome, etc.
+      placeholder: e.g macOS Safari 14.1
+    validations:
+      required: true
+  - type: checkboxes
+    id: checkboxes
+    attributes:
+      label: Validations
+      description: Before submitting the issue, please make sure you do the following
+      options:
+        - label: Read the [docs](http://jquense.github.io/react-big-calendar/examples).
+          required: true
+        - label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
+          required: true
+        - label: Make sure this is a react-big-calendar issue and not an implementation issue
+          required: true
+  - type: checkboxes
+    id: pr
+    attributes:
+      label: Would you like to open a PR for this bug?
+      description: Before starting to work on PR it is recommended to get maintainers approval. The fastest, and most appreciated way to have your issue fixed is to create a pull request with working, tested code and we will help get it merged. Don't be scared to open a pull request that isn't completed and ask for input. We're happy to give direction!
+      options:
+        - label: I'm willing to open a PR
+          required: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+
+The best way to propose a feature is to open an issue first and discuss your ideas there before implementing them.
+
+Always follow the [contribution guidelines](https://github.com/jquense/react-big-calendar/blob/master/CONTRIBUTING.md) when submitting a pull request.

.github/workflows/issue-close-require.yml

@@ -0,0 +1,17 @@
+name: Issue Close Require
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    steps:
+      - name: missing demo
+        uses: actions-cool/issues-helper@v2.2.1
+        with:
+          actions: 'close-issues'
+          token: ${{ secrets.GITHUB_TOKEN }}
+          labels: 'missing demo'
+          inactive-day: 3

.github/workflows/issue-labeled.yml

@@ -0,0 +1,19 @@
+name: Issue Labeled
+
+on:
+  issues:
+    types: [labeled]
+
+jobs:
+  reply-labeled:
+    runs-on: ubuntu-latest
+    steps:
+      - name: missing demo
+        if: github.event.label.name == 'missing demo'
+        uses: actions-cool/issues-helper@v2.2.1
+        with:
+          actions: 'create-comment, remove-labels'
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.issue.number }}
+          body: |
+            Hello @${{ github.event.issue.user.login }}. Please provide an online reproduction by [codesandbox](https://codesandbox.io/) or a minimal GitHub repository. You can fork our [Issue Template](https://codesandbox.io/s/react-big-calendar-example-v9wdyd) in codesandbox to get start. Issues labeled by `missing demo` will be closed if no activities in 3 days.

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Node.js
         uses: actions/setup-node@v2

.github/workflows/storybook.yml

@@ -0,0 +1,32 @@
+name: Build and Deploy Documentation
+on: 
+  workflow_run:
+    workflows: ["Release"]
+    types: [completed]
+    branches:
+      - master
+    paths:
+      - 'src/**'
+      - 'stories/**'
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+
+      - name: Install and Build 🔧
+        run: | # Install npm packages and build the Storybook files
+          npm ci
+          npm run build-storybook
+
+      - name: Deploy 🚀
+        # https://github.com/JamesIves/github-pages-deploy-action
+        uses: JamesIves/github-pages-deploy-action@v4.2.5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages # The branch the action should deploy to.
+          folder: storybook-static # The folder that the build-storybook script generates files.
+          target-folder: examples
+          clean: true # Automatically remove deleted files from the deploy branch
+          commit-msg: 'docs: update documentation site'

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Node.js
         uses: actions/setup-node@v2

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx --no-install commitlint --edit "$1"
+npx --no-install commitlint --edit ""

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.lintstagedrc

@@ -0,0 +1,7 @@
+{
+    "src/**/*.js": "eslint",
+    "test/**/*.js": "eslint",
+    "*.{js,json,css,md}": [
+      "prettier --write"
+    ]
+  }

.npmignore

@@ -0,0 +1,5 @@
+.*
+stories
+test
+src
+*.config.js

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "printWidth": 80,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true
+}