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

The readme does not say or lead to everything that people need to know #268

Open
rptb1 opened this issue Oct 9, 2023 · 2 comments
Open
Labels
essential Will cause failure to meet customer requirements. Assign resources.

Comments

@rptb1
Copy link
Member

rptb1 commented Oct 9, 2023

The MPS readme is oriented towards the MPS as a product supported by Ravenbrook. But now we want to foster its use as a community open source project, so it should cover things like contribution, planning, forking, and other management topics. Or at least point to further information. If someone comes across the repository somehow (wherever it is) we want them to be able to do things with it.

@thejayps
Copy link
Contributor

I think a good way to slice this information for a potential new contributor (especially if they discover the MPS at some future time when it may not be being actively worked on by anyone else) would be according to the resource they have at their disposal. Some of our procedures require 2 or more people to complete. We could estimate the effect on quality of trying to complete those procedures without the intended resource to help potential contributors manage their expectations

@thejayps thejayps changed the title The readme does say or lead to everything that people need to know The readme does not say or lead to everything that people need to know Oct 31, 2023
@thejayps
Copy link
Contributor

This is related to migration, because we need to absorb anything on the front page of the project into the readme: #98

@thejayps thejayps added the essential Will cause failure to meet customer requirements. Assign resources. label Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
essential Will cause failure to meet customer requirements. Assign resources.
Projects
None yet
Development

No branches or pull requests

2 participants