Skip to content
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: update CONTRIBUTING.md #577

Closed
4 tasks
alestiago opened this issue Mar 22, 2023 · 2 comments · Fixed by #648
Closed
4 tasks

docs: update CONTRIBUTING.md #577

alestiago opened this issue Mar 22, 2023 · 2 comments · Fixed by #648
Labels
documentation Improvements or additions to documentation

Comments

@alestiago
Copy link
Contributor

alestiago commented Mar 22, 2023 •
edited

Description

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

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

Requirements

  • 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
@alestiago alestiago added the documentation Improvements or additions to documentation label Mar 22, 2023
@easazade
Copy link
Contributor

easazade commented Apr 8, 2023 •
edited

and how do you manage the mono-repo?
usually i see melos package is used for that.

Do you create a workspace in your IDE or is there any other tools you guys use internally in your team?

@alestiago
Copy link
Contributor Author

Linking this related comment here #631 (comment)

@alestiago alestiago mentioned this issue May 17, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
VGV Open Source 🦄 🧙🌟
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: include CONTRIBUTING.md for dart_frog_cli VeryGoodOpenSource/dart_frog
2 participants
@easazade @alestiago