From 03998b2fb6984f42b7cc1fa186148bcdb35f66aa Mon Sep 17 00:00:00 2001 From: twist Date: Tue, 20 Sep 2022 13:13:20 +0200 Subject: [PATCH] Add readme --- .github/pull_request_template.md | 5 ++++ README.md | 49 ++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 .github/pull_request_template.md create mode 100644 README.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3f6f818 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,5 @@ +## Describe your changes + +## Issue ticket number and link + +## Checklist before requesting a review \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f9ed36b --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# MBAZA-NLP WEBSITE + +## Table of Contents + +* [Tech stack and main functions](#tech-stack) +* [Include how to contribute, push to the website](#how-to-contribute) +* [PR template](#pr-template) +* [Issue template](#issue-template) +* [Community Channels](#community-channels) +* [Contributers](#contributers) + + + +## tech-stack +* [HTML](https://www.w3schools.com/html/) +* [JAVASCRIPT](https://developer.mozilla.org/en-US/docs/Web/JavaScript) + + + +## how-to-contribute + ``` bash + # Raise a PR from your feature branch dev branch + # Wait for a review + # Your changes Will merged by the reviewer + ``` + + + +## pr-template +* [Template](.github/pull_request_template.md) + + +## community-channels +* [Slack](https://join.slack.com/t/mbazanlpcommunity/shared_invite/zt-1e5mxv2x2-XH25edKoZ4tFZou4SvLsQA) + + +## contributers +* [Olivier IRADUKUNDA](https://github.com/twist250) +* [Sam RUTUNDA](https://github.com/rutsam) + + + + + + + + + +