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.

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

Mauro repositories/documentation lacks instructions and guidance for contributors/developers #62

Open
pjmonks opened this issue Jul 4, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@pjmonks
Copy link
Contributor

pjmonks commented Jul 4, 2022

A lot of open source projects carry guidance on how to contribute to their projects effectively, which is incredibly useful for newcomers to the project who wish to help and need to get started. The current documentation does have a contribution page but could go into a lot more detail.

From a development perspective at least I can think of:

  1. Which issues are able to be worked on, and who decides that?
  2. Basic process instructions - assigning issues, changing to correct state in the board, etc
  3. Submitting pull requests - what to check before submitting, the management process behind the PR and related issue(s), review process etc

Also, these instruction may appear on the documentation site, but a developer's first port of call will typically be the README of a repository, so they should at least be directed to the documentation page.

Some examples of contribution guidelines (though there are many) are:

  1. Angular
  2. Groovy
@pjmonks pjmonks added this to MDM State Jul 4, 2022
@pjmonks pjmonks moved this to Backlog in MDM State Jul 4, 2022
@pjmonks pjmonks added the enhancement New feature or request label Jul 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant