Comments (5)
@Phu2 @acka47 I think you both should do the review of the guidelines:
https://github.com/skohub-io/skohub-vocabs/blob/242-contributingGuidelines/CONTRIBUTING.md
For SkoHub this especially means focussing more on the distinction between functional and code review.
Currenty we do not assign functional reviewers and do both in the PR.
We should also pay more attention to the definition of ready. I added a note about features that requires a small user story (if possible and sensible) so we get a more detailed picture of how that feature is going to be used. As well should a small check list be provided that makes it easy to know, when the requirements are met.
from skohub-vocabs.
+1
The proposed changes sound reasonable to me.
from skohub-vocabs.
Other than the metafacture guideline I propose a workflow where the person, who opens the pull request is also the assignee of the pull request. (...)
Also I propose a workflow, where the issue remains assgined to the person originally working on it.
I don't see this being clearly expressed in the current draft. For example this reads as if un- and re-assignments are expected:
Issues in working are only reassigned by the person who is currently assigned. If the assignee thinks the issue is ready for review they add instructions and links for testing the changed behavior in the issue, move it to the Review column, assigns the previously announced functional reviewer (see Definition of Ready), and open an pull request for the feature branch. The assignee of the pull request is the original assignee of the issue.
Here are some more thoughts I had while reading it:
- I am not sure whether these two points should actually be listed in the "submitting enhancements" section (in this draft as well as in the Metafacure Contributing.md where it is copied from) as it rather sounds like a bug-related scenario:
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Not directly an issue with the CONTRIBUTING.md: In the "Definition of Done" I am missing the point that the functionality is actually deployed to production. We should make sure in our process that this is done. (Thinking about one or two cases in the recent past where the main branch wasn't deployed.) However, this does not need to be written into the CONTRIBUTING.md as it is instance agnostic.
from skohub-vocabs.
Also, I have a question re. the "Releasing SkoHub" paragraph: Is this something we already do or is it just a plan to do it like this?
from skohub-vocabs.
@acka47 Thanks for the feedback.
Re: Assignment:
I reworked the mentioned sections and hope it is now a bit clearer.
Re: Submitting enhancements
I think you are right. I removed the two points.
Re: Deployment
This should now be fixed with #217
A merge in main branch triggeres the built of a new docker image, which is then automatically pulled by skohub-webhook. Therefore vocabs are always built with the most current version now.
Re: Releasing SkoHub Vocabs
I think we did not yet decide if we need releases. I removed that part for now.
btw: I moved discussion here, because in the first draft I copied the approach from metafacture that discussion of functional review should happen in the issue. And this is kind of a functional review.
But after rework of that section I propose the approach that after an issue is ready and someone has a change ready and makes a PR the functional review and code review move to the PR. Therefore I will now open a PR and reassign you there.
from skohub-vocabs.
Related Issues (20)
- Inversion of topConceptOf und hasTopConcept
- Discussion: SkoHub Vocabs Index Page HOT 1
- Add Tests
- skohub-docker-vocabs does not work after node upgrade
- Add a note in the README that SkoHub Vocabs works best with Slash URIs HOT 1
- Add inverse of `skos:member`
- Setup container based development process HOT 1
- Add README to Docker Hub when building image with GitHub Action
- Add Info about SKOS Shape in README HOT 1
- SkoHub: Move webhook related issues to webhook repo
- Fonts are not loaded in production
- Scrolling down the vocab tree doesn't work anymore
- Config is loaded multiple times
- Two concept schemes in one file or one concept scheme across multiple files break build
- Two URIs for `skos:inScheme` breaks building of concept page HOT 4
- Problems with Hebrew characters HOT 9
- Add check against SKOS Shape to SkoHub Vocabs HOT 3
- Add build info in vocabulary
- Enhance usability/accessibility of concepts HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from skohub-vocabs.