Merge pull request #37 from devfemmy/add-contribution-guidelines

Add contribution guidelines

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Test and Lint the changes
+
+on: 
+  push:
+
+jobs:
+  build-and-deploy:
+    name: Build, lint, and test on Node 14.x
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Install Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 18.x
+
+      - name: Install deps and build (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test --ci --coverage --maxWorkers=2

.github/workflows/main.yml

@@ -1,5 +1,9 @@
-name: CI
-on: [push]
+name: Deploy the changes
+on: 
+  push:
+    branches:
+      - 2_0
+
 jobs:
   build-and-deploy:
     name: Build, lint, and test on Node 14.x
@@ -18,12 +22,6 @@ jobs:
       - name: Install deps and build (with cache)
         uses: bahmutov/npm-install@v1
 
-      # - name: Lint
-      #   run: yarn lint
-
-      # - name: Test
-      #   run: yarn test --ci --coverage --maxWorkers=2
-
       - name: Build
         run: yarn build && yarn build-storybook
       - uses: JS-DevTools/npm-publish@v2

CONTRIBUTING.MD

@@ -0,0 +1,18 @@
+
+This repository uses TSDX by Jared Palmer, it follows the same convention.
+
+Contribution guidelines:
+- Fork the repository
+- Add make a change
+- Add example to illustrate the result of your change
+- Please include test
+- Submit a PR to this repo, and ask for a review.
+- Wait for your changes to be merged.
+
+
+Possible things to do:
+- Add more examples
+- Include more storybook examples
+- HereMaps has a new feature? Add it in!
+- Rewrite for performance optimizations.
+

README.MD

@@ -1,5 +1,4 @@
 
-
 # react-here-map
 
 React components for rendering and working with
@@ -24,15 +23,13 @@ Using NPM:
 npm i --save react-here-map
 ```
 ---
-
 Using Yarn:
 
 ---
 ```bash
 yarn add react-here-map
 ```
 ---
-
 ## General Usage
 
 ---
@@ -103,7 +100,6 @@ ReactDOM.render(
 );
 ```
 ---
-
 ## CHANGES
 
 **06/05/2020**
@@ -112,7 +108,7 @@ ReactDOM.render(
 
 ## Contributions
 
-See the TODO.MD
+See the [./CONTRIBUTING.MD](CONTRIBUTING.MD)
 
 ## Licence