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

Encourage public demo #55

Open
Ainali opened this issue Jun 9, 2021 · 4 comments
Open

Encourage public demo #55

Ainali opened this issue Jun 9, 2021 · 4 comments
Labels
question Further information is requested

Comments

@Ainali
Copy link
Contributor

Ainali commented Jun 9, 2021

Several times in presentations of a codebase it has become clear that they would have benefited from having a demo version available so that potential reusers can try it out, even if it is in a limited way. Should we have a MAY, or perhaps even a SHOULD, requirement about that?

@Ainali Ainali added the question Further information is requested label Jun 9, 2021
@Ainali
Copy link
Contributor Author

Ainali commented Mar 6, 2023

If we should have a requirement, I think it perhaps fit best in Document codebase objectives.

@ericherman
Copy link
Contributor

Is this more of a testing requirement?

We should be able to test the running code separately from a production deployment, yes?

@Ainali
Copy link
Contributor Author

Ainali commented Mar 6, 2023

Is this more of a testing requirement?

Not really. When I created the issue, I reflected on that people had a hard time explaining what benefits the codebase would bring and that a "show, don't tell" approach would have been better. In that sense, it kind of relates to all three requirements in Document codebase objectives.

We should be able to test the running code separately from a production deployment, yes?

Yes, but I think that might be implicitly covered by "Reviews SHOULD include running both the code and the tests of the codebase." in Require reviews of contributions.

@ericherman ericherman changed the title Requirement about demo version? Encourage public demo Mar 28, 2023
@ericherman ericherman transferred this issue from standard-for-public-code/standard-for-public-code Mar 28, 2023
@ericherman
Copy link
Contributor

Let's find some clear examples of this to inspire implementors in other codebases

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants