New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: include `CONTRIBUTING.md` #44

Open

5 tasks

alestiago opened this issue Mar 22, 2023 · 0 comments

Labels

documentation p3

Contributor

alestiago commented Mar 22, 2023 •

edited

Loading

Description

As a developer interested in contributing I would like to have a CONTRIBUTING.md file that outlines:

How to run the tool in my local environment
How the overall structure of the tool works (explained with correct visualisations)
Know on what features the team would like external contributors to work and how to create a correct pull request.

Requirements

Include a CONTRIBUTING.md file
Explain how the tool works internally (with visualisations)
Include instructions on how to run the tool in my local environment (for MacOs, Windows and Linux)
Include instructions on how to find features available for contribution or suggest features
Include instructions on how to open a good pull request or issue

The text was updated successfully, but these errors were encountered:

alestiago added the documentation label

alestiago added this to VGV Open Source 🦄 🧙🌟

alestiago moved this to Needs Triage in VGV Open Source 🦄 🧙🌟

alestiago changed the title ~~docs: include CONTRIBUTING.md~~ docs: include CONTRIBUTING.md

BeatriceMitchell moved this from Needs Triage to Backlog in VGV Open Source 🦄 🧙🌟

tomarra added the p3 label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment