Skip to content
New issue

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

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

Already on GitHub? # to your account

Create a "Getting Started" reference document explaining best practises for a compliant project #36

Open
janhalen opened this issue May 1, 2024 · 6 comments

Comments

@janhalen
Copy link
Member

janhalen commented May 1, 2024

Create a document that gives practical actionable best practises on how to get started working with software projects that are compliant with the governance template.

@janhalen janhalen changed the title Create a reference document Create a "Getting Started" reference document explaining best practises for a compliant project May 1, 2024
@janhalen janhalen added this to the Template revision 1.1 milestone May 1, 2024
@janhalen
Copy link
Member Author

janhalen commented May 7, 2024

  • It should be clearer in section 2 "request a sandbox" that os2 will assist in repository onboarding..

Text changed-> https://github.com/OS2offdig/governance_report_template/blob/36-create-a-getting-started-reference-document-explaining-best-practises-for-a-compliant-project/docs/Getting_started.md

@janhalen
Copy link
Member Author

janhalen commented May 7, 2024

  • It should be elaborated that os2 can help setting up github issues as issue tracker. to link the work being done easily to the issues.. If some other system is used, a link between the feature branches and the issues should be set up.

@janhalen
Copy link
Member Author

janhalen commented May 7, 2024

  • In the "upstream" section, there should be linked to a explanation of the benefits of upstream. Use the term "Reuse" and link out.

  • added "♻️ Design the solution with reusable components"

  • Mention other os2 products as upstream candidates.. both services and existing products. Research the existing portfolio for existing products that solve the same challenges...

@janhalen
Copy link
Member Author

janhalen commented May 14, 2024

  • Explain the term "user stories" by linking out

@zorp : We need to discuss the refernce here.. what is a good source explaning user stories to the audience of this doc? If they are reading this doc, arent they a user type that alleready knows what at User Story is?

@janhalen
Copy link
Member Author

janhalen commented May 31, 2024

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
1 participant