search

epiverse-trace / blueprints

Software development blueprints for epiverse-trace
https://epiverse-trace.github.io/blueprints
Other
4 stars 4 forks source link

Update few files #92

Closed Karim-Mane closed 5 months ago

Karim-Mane commented 6 months ago

In this PR, I have fixed few typos and raised few questions/suggestions:

  1. In the section Software development as co-creation, consider adding a link to resources that explain how to acknowledge contributions from collaborators on the following point:

    • User contributions need to be valued and acknowledged clearly. See here for more details.

  2. On the same section, might be worth considering a broader view of pair-programming:

    • Co-creation can also take the form of pair-programming to combine domain experts and developers I think pair-programming also includes the combination of 2 developers to code as they brainstorm.

  3. On the Documentation section:

    • Provide user-friendly cheatsheets in html and pdf: is it possible to provide a list of these cheatsheets?
netlify[bot] commented 6 months ago

Deploy Preview for playful-gelato-7892ba ready!

Name Link
Latest commit 4301877d785987c10298e4bcb08ec181a2e14fe6
Latest deploy log https://app.netlify.com/sites/playful-gelato-7892ba/deploys/660e89abcfb41e00084efa7a
Deploy Preview https://deploy-preview-92--playful-gelato-7892ba.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Karim-Mane commented 6 months ago

Thanks for the PR. I have asked to revert a couple of changes because I believe they were correct.

Regarding your questions:

1. Could you submit a PR to add a link to the contributions chapter in https://github.com/epiverse-trace/blueprints/blob/bf64c4f0367bc25575ccb878bcf01342d3a9e4aa/principles.qmd#L35-L40
   ?

can't it be done on this PR? given that I have reverted some changes to what was there before as you suggested.

2. I believe what we meant is that co-creation with domain experts can be done via pair programming. Please suggest a better phrasing if it's unclear

I agree with co-creation with domain experts can be done via pair programming as it's simpler to my opinion.

3. We don't have cheatsheets at the moment as far as I know but here are examples outside of Epiverse: https://rstudio.github.io/cheatsheets/contributed-cheatsheets.html

thanks for sharing this. Maybe consider adding this as an example:

Bisaloo commented 6 months ago

Yes, please feel free to add these 3 changes in this PR.

chartgerink commented 5 months ago

If you would like to add any further changes please provide a new PR. I will now merge this as it's been open for over a month without updates, plus the included changes are very minor.

I approved the PR to document my approval of the current state.