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

Add contributing.md to these metafacture repos #391

Closed
2 tasks done
dr0i opened this issue Sep 10, 2021 · 8 comments
Closed
2 tasks done

Add contributing.md to these metafacture repos #391

dr0i opened this issue Sep 10, 2021 · 8 comments

Comments

@dr0i
Copy link
Member

dr0i commented Sep 10, 2021

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
Copy link
Member

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

@katauber
Copy link
Member

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
Copy link
Contributor

acka47 commented Sep 17, 2021

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.

@acka47 acka47 removed their assignment Sep 20, 2021
@katauber katauber removed their assignment Sep 20, 2021
@fsteeg
Copy link
Member

fsteeg commented Sep 30, 2021

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
Copy link
Member

fsteeg commented Sep 30, 2021

+1 for:

  • separate, short contributing.md in metafacture-blog
  • linking to the metafacture-core contributing.md from metafacture-flux and metafacture-fix

@fsteeg fsteeg removed their assignment Sep 30, 2021
@TobiasNx
Copy link
Contributor

+1 for:

* separate, short contributing.md in metafacture-blog

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

+1

@TobiasNx TobiasNx removed their assignment Sep 30, 2021
dr0i added a commit to metafacture/metafacture-flux that referenced this issue Oct 4, 2021
Pointing to metafacture-core's CONTRIBUTING.md as discussed in
metafacture/metafacture-core#391.
dr0i added a commit to metafacture/metafacture-fix that referenced this issue Oct 4, 2021
Pointing to metafacture-core's CONTRIBUTING.md as discussed in
metafacture/metafacture-core#391.
@dr0i
Copy link
Member Author

dr0i commented Oct 4, 2021

@dr0i
Copy link
Member Author

dr0i commented Oct 4, 2021

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

@dr0i dr0i closed this as completed Oct 4, 2021
Metafacture alt automation moved this from Review to Done Oct 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

6 participants