search

metafacture / metafacture-core

Core package of the Metafacture tool suite for metadata processing.
https://metafacture.org
Apache License 2.0
69 stars 34 forks source link

Add contributing.md to these metafacture repos #391

Closed dr0i closed 2 years ago

dr0i commented 2 years ago

We elaborated a comprehensive CONTRUBUTING.md and thought about providing it to some other metafacture-repos where this would make sense:

~- [ ] https://github.com/metafacture/metafacture-blog~ (will have an CONTRIBUTING.md on its own)

We would add a CONTRIBUTING.md to these repos consisting of just a link pointing to the one residing here.

Conflicts: a) in metafacture-playground there is already a CONTRIBUTING.md. b) Also, it seems to me that at least the last part of this repo's CONTRIBUTING.md "Releasing Metafacture" should then be somehow capsulated or made be more generic so that it could be applied to all there repos.

blackwinter commented 2 years ago

Are there any plans to integrate metafacture-fix and metafacture-flux into metafacture-core? (See also metafacture/metafacture-flux#13)

katauber commented 2 years ago

We elaborated a comprehensive CONTRUBUTING.md and thought about providing it to some other metafacture-repos where this would make sense:

I think maybe for metafacture-blog it would be better to have an own CONTRIBUTING.md. If I read as example the "how do I submit a bugreport"-section in the metafacture-core CONTRIBUTING.md, parts like "Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you are running Metafacture (e.g. running flux.sh/flux.bat or as a Java library)." does not fit for a blog.

Conflicts: a) in metafacture-playground there is already a CONTRIBUTING.md.

I think we already discussed that if a repo has an own CONTRIBUTING.md we don't need a link to the metafacture-core CONTRIBUTING.md. Do you miss something in the metafacture-playground CONTRIBUTING.md which is in the metafacture-core CONTRIBUTING.md? If yes, we can open a ticket in metafacture-playground and add these parts to the metafacture-playground CONTRIBUTING.md.

acka47 commented 2 years ago

Re. metafacture-blog, we could a dd a rather short CONTRIBUTING.md which documents how to create a PR with a new blog post. Thus, community members could quite easily write about their experiences with Metafacture. From my point of view we could also leave a CONTRIBUTING.md for metafacture-blog out for now.

fsteeg commented 2 years ago

Are there any plans to integrate metafacture-fix and metafacture-flux into metafacture-core? (See also metafacture/metafacture-flux#13)

No current plans. Long term, if our Xtext / language server protocol (LSP) approach for Fix tooling (in VS code/codium extension and Playground) works out, it might make more sense to move the Flux implementation out of metafacture-core and into metafacture-flux. If the LSP approach doesn't work out, it might make sense to move metafacture-fix into metafacture-core (with a plain ANTLR implementation).

fsteeg commented 2 years ago

+1 for:

TobiasNx commented 2 years ago

+1 for:

* separate, short contributing.md in metafacture-blog

* linking to the metafacture-core contributing.md from metafacture-flux and metafacture-fix

+1

dr0i commented 2 years ago

Opened https://github.com/metafacture/metafacture-flux/pull/14. Opened https://github.com/metafacture/metafacture-blog/issues/10. Opened https://github.com/metafacture/metafacture-fix/pull/56.

dr0i commented 2 years ago

We identified two repos and referenced their CONTRIBUTING.md to the one here. Closing.