Add contribution guidelines (#42)

Also updates the README a bit

fixes #41

README.md

@@ -6,14 +6,26 @@ This is an app that will be able to dynamically import and schedule GitHub workf
 
 ## Getting started
 
-First, install and setup the environment:
+Hello there! 👋
+
+Thank you for taking the time to check out this project. Looking to contribute? Great! Please read the [contribution guidelines](docs/CONTRIBUTING.md) first.
+
+### Quick start local development
+The repository comes with a local `docker-compose` that can be used for development.
 
 ```bash
-yarn install
-yarn prepare  # installs the git commit and push hooks
-```
+# Copy example env file (and update the values if needed)
+cp .env-example .env
+
+# Build and start the app
+docker compose up --build -d
 
-Copy the `.env-example` to `.env` and update all of the values.
+# (optional but recommended) i a separate terminal
+ngrok http 3000
+
+# Create all of the tables in the database on the first run
+npx prisma db push
+```
 
 ## Running local development
 

docs/CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Workflow Manager Contribution Guidelines
+
+Welcome to the Workflow Manager open-source project! We appreciate your interest in contributing to our project. By contributing, you not only help improve the project but also become a part of our community.
+
+Before you start contributing, please take a moment to review these guidelines, as they will help streamline the contribution process and ensure that everyone has a positive experience.
+
+
+## Table of Contents
+- [Contributing](#contributing)
+- [Getting Started](#getting-started)
+- [Review Process](#review-process)
+- [Documentation](#documentation)
+
+### Contributing
+
+#### Issues
+Did you find a bug? Something that doesn't work as expected? Please [create a bug issue](https://github.com/codelabsab/workflow-manager/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) in the GitHub repository.
+
+#### Feature Requests
+Do you have an idea for a new feature? Great! Hopefully there is an open issue for this or there is an existing discussion in the [Discussions](https://github.com/codelabsab/workflow-manager/discussions/categories/ideas) that you can link to. This is to make sure that your suggestion is in line with the project's goals, which in turn makes it easier to accept your contribution.
+
+### Getting Started
+
+#### Fork the Repository
+To contribute, fork this repository by clicking the "Fork" button at the top right corner of the page. This will create a copy of the repository in your GitHub account.
+
+#### Set Up Your Development Environment
+Depending on the change you want to make, you might want to set up your development environment. This can be found in the [README.md](../README.md) file.
+
+### Review Process
+All pull requests will be reviewed by project maintainers. Be prepared to address feedback and make changes to your code if necessary. Once your PR is approved, it will be merged by a maintainer.
+
+We will try to review your PR as soon as possible. Don't be afraid to ping us if you feel that it has been forgotten.
+
+### Documentation
+Update the project's documentation, if applicable, to reflect your changes. Clear and up-to-date documentation is essential.
+
+### License
+By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.
+
+Thank you for contributing to Workflow Manager! Your help is greatly appreciated.