Merge pull request #24 from celo-org/arthurgousset/github-setup

Adds Github setup files

.github/CODEOWNERS

@@ -0,0 +1,6 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+# For details on acceptable file patterns, please refer to the [Github Documentation](https://help.github.com/articles/about-codeowners/)
+
+# default owners, overridden by package specific owners below
+* @celo-org/devtooling

.github/ISSUE_TEMPLATE/BUG-FORM.yml

@@ -0,0 +1,36 @@
+name: Bug report
+description: File a bug report
+labels: ["bug report"]
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Please ensure that the bug has not already been filed in the issue tracker.
+
+              Thanks for taking the time to report this bug!
+    - type: input
+      attributes:
+          label: What version of the package are you on?
+          description: |
+            For local installations, run: `npm list <package-name>`
+            For global installations, run: `npm list -g <package-name>`
+          placeholder: "Run command above and paste the output here"
+    - type: input
+      attributes:
+          label: What command or function is the bug in?
+          description: Leave empty if not relevant
+    - type: dropdown
+      attributes:
+          label: Operating System
+          description: What operating system are you on?
+          options:
+              - Windows
+              - macOS (Intel)
+              - macOS (Apple Silicon)
+              - Linux
+    - type: textarea
+      attributes:
+          label: Describe the bug
+          description: Please include relevant code snippets, terminal output, and screenshots if relevant.
+      validations:
+          required: true

.github/ISSUE_TEMPLATE/FEATURE-FORM.yml

@@ -0,0 +1,20 @@
+name: Feature request
+description: Suggest a feature
+labels: ["feature request"]
+body:
+    - type: markdown
+      attributes:
+          value: |
+              Please ensure that the feature has not already been requested in the issue tracker.
+
+              Thanks for helping us improve Celo packages!
+    - type: textarea
+      attributes:
+          label: Describe the feature you would like
+          description: Please also describe what the feature is aiming to solve, if relevant.
+      validations:
+          required: true
+    - type: textarea
+      attributes:
+          label: Additional context
+          description: Add any other context to the feature (like screenshots, code snippets, resources)

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Github Discussions
+    url: https://github.com/celo-org/compliance/discussions
+    about: Please ask and answer questions here.
+  - name: Docs
+    url: https://docs.celo.org/
+    about: Documentation on the Celo Platform

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+### Description
+
+_A few sentences describing the overall effects and goals of the pull request's commits.
+What is the current behavior, and what is the updated/expected behavior with this PR?_
+
+### Other changes
+
+_Describe any minor or "drive-by" changes here._
+
+### Tested
+
+_An explanation of how the changes were tested or an explanation as to why they don't need to be._
+
+### Related issues
+
+- Fixes #[issue number here]
+
+### Backwards compatibility
+
+_Brief explanation of why these changes are/are not backwards compatible._
+
+### Documentation
+
+_The set of community facing docs that have been added/modified because of this change_

CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing
+
+Thank you for your interest in improving `@celo/compliance`.
+
+If you want to contribute, but aren't sure where to start, you can create a
+[new discussion](https://github.com/celo-org/compliance/discussions).
+
+There are multiple opportunities to contribute. It doesn't matter if you are just
+getting started or are an expert. We appreciate your interest in contributing.
+
+> **IMPORTANT**
+> Please ask before starting work on any significant new features.
+>
+> It's never a fun experience to have your pull request declined after investing time and effort
+> into a new feature. To avoid this from happening, we invite contributors to create a
+> [new discussion](https://github.com/celo-org/compliance/discussions) to discuss API changes or
+> significant new ideas.
+
+## Basic guide
+
+This guide is intended to help you get started with contributing. By following these steps,
+you will understand the development process and workflow.
+
+### Cloning the repository
+
+To start contributing to the project, clone it to your local machine using git:
+
+```sh
+$ git clone https://github.com/celo-org/compliance.git
+```
+
+Navigate to the project's root directory:
+
+```sh
+$ cd compliance
+```
+
+### Installing Node.js
+
+We use [Node.js](https://nodejs.org/en/) to run the project locally.
+
+### Installing dependencies
+
+Once in the project's root directory, run the following command to install the project's 
+dependencies:
+
+```sh
+$ yarn install
+```
+
+After installing the dependencies, the project is ready to be run. 
+
+### Navigating the repository
+
+The project is mostly based on Github Actions implemented in the 
+[`.github/workflows`](./.github/workflows) directory.
+
+### Running packages
+
+Once you navigated to the project directory you want to run, inspect the `package.json` file
+and look for the `scripts` section. It contains the list of available scripts that can be run.
+
+### Versioning
+
+The package is automatically versioned by the CI/CD pipeline. The version is typically 
+a patch version if changes are made to the OFAC addresses, but it can be a minor or major version 
+if we make changes to the API or the package structure.
+
+### Running the test suite 
+
+We don't have a test suite for this package yet, but you can inspect the scripts in 
+[`./scripts`](./scripts/), which are designed to manually check OFAC addresses.
+
+When you open a Pull Request, the GitHub CI will run any available test suites for you, but 
+you can also add and run tests locally.
+
+> **INFO**
+> Some tests are run automatically when you open a Pull Request, while others are run when a 
+> maintainer approves the Pull Request. This is for security reasons, as some tests require access 
+> to secrets.
+
+### Open a Pull Request
+
+✅ Now you're ready to contribute!