You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by GitBox <gi...@apache.org> on 2023/01/17 17:47:24 UTC
[GitHub] [incubator-pekko] kw217 opened a new issue, #112: Clearly describe current project state and how to contribute
kw217 opened a new issue, #112:
URL: https://github.com/apache/incubator-pekko/issues/112
Update `README.md` and `CONTRIBUTING.md` to clearly describe the current state of the project and how best to contribute to it.
We want to encourage people to help get Pekko to v1.0, and ensure it's clear that this is being actively worked on. We don't want to discourage people with inaccurate docs, or by appearing to claim Pekko is ready for use now when it's not.
I'm keen to hear other folks' thoughts, but here are some things I think we could do to improve the situation:
* Near the top of the README, say "Pekko is part of the Apache Incubator program and we are actively working towards a v1.0 release. It's not yet ready for production use, but please get involved with the community and contribute to the effort."
* In CONTRIBUTING (or possibly even README), add a section explaining that we are working on `incubator-pekko` first and not touching any of the other repos. This is quite important and not immediately obvious.
* In CONTRIBUTING, remove (or demote) the section that lists how Akka used to use tags (labels). We aren't using these yet. If we are using labels etc, explain that instead.
* Agree on label/milestone usage: I can see we're using `milestone:1.1.0` for things that don't belong in the initial release; I think we should use `blocked` for issues that are blocked, e.g., #101. I wonder if there's a way we can label priorities or classes of issues to make the list more manageable?
* In CONTRIBUTING, add some kind of table of contents - otherwise it's not obvious that build instructions are down below.
I also think we should try to get the complete list of things needed to reach v1.0 raised as issues, rather than relying on memory and mailing lists. That way we have an accurate work list, and we can tell folks "check GitHub for the current list of open issues, read the discussion, and dive in".
Feedback welcome - I'm new to this project and am probably missing important context. Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] sam-byng commented on issue #112: Clearly describe current project state and how to contribute
Posted by "sam-byng (via GitHub)" <gi...@apache.org>.
sam-byng commented on issue #112:
URL: https://github.com/apache/incubator-pekko/issues/112#issuecomment-1460561860
Responding to the above with some more context and proposals:
> • Near the top of the README, say "Pekko is part of the Apache Incubator program and we are actively working towards a v1.0 release. It's not yet ready for production use, but please get involved with the community and contribute to the effort."
From 4 months ago, there is a basic entry in the README [contributing](https://github.com/apache/incubator-pekko#contributing) section which states "Contributions are very welcome" however yes, more encouragement and clarity on status for potential contributors doesn't feel like a bad thing! I propose adding this. TODO: get sign off from project mentors.
> • In CONTRIBUTING (or possibly even README), add a section explaining that we are working on incubator-pekko first and not touching any of the other repos. This is quite important and not immediately obvious.
I am not sure whether this is true or not anymore, so therefore we would not need this comment right now. TODO: discuss with project mentors.
> • In CONTRIBUTING, remove (or demote) the section that lists how Akka used to use tags (labels). We aren't using these yet. If we are using labels etc, explain that instead.
Agreed, it doesn't look like we're using any of these labels on the incubator-pekko issues right now ([Issues · apache/incubator-pekko (github.com)](https://github.com/apache/incubator-pekko/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3Ablocked+label%3Abug+label%3Adocumentation+label%3Aduplicate+label%3Aenhancement+label%3A%22help+wanted%22+label%3Ainvalid+label%3Aquestion+label%3Awontfix)) so I would vote to remove this for now. TODO: get sign off from project owners.
> • Agree on label/milestone usage: I can see we're using milestone:1.1.0 for things that don't belong in the initial release; I think we should use blocked for issues that are blocked, e.g., Upgrade Jackson dependency to 2.13.4 for CVE-2020-36518 CVE-2022-42004 CVE-2022-42003 #101. I wonder if there's a way we can label priorities or classes of issues to make the list more manageable?
I think this is one for wider discussion in the mailing list. I will search for discussions of this / make a new discussion and update below.
> • In CONTRIBUTING, add some kind of table of contents - otherwise it's not obvious that build instructions are down below.
TODO: I can do this however would like to get sign off from project mentors.
> I also think we should try to get the complete list of things needed to reach v1.0 raised as issues, rather than relying on memory and mailing lists. That way we have an accurate work list, and we can tell folks "check GitHub for the current list of open issues, read the discussion, and dive in".
From a newcomers perspective I've spend ~1d looking around the pekko documentation + mailing list and haven't yet got a clear picture of whether we've got a complete list for 1.0.0 requirements or not.
AFAICT the list of things required for the `incubator-pekko` (core repo) to get to 1.0.0 is tracked in the [1.0.0 Milestone](https://github.com/apache/incubator-pekko/milestone/1) . Though I think there there might be some missing items there (e.g. [#110](https://github.com/apache/incubator-pekko/issues/110)) .
However, in the mailing list thread: [M0 release for incubator-pekko repo](https://lists.apache.org/thread/cx3t7g9rs44tchoz4jytb74sdtlq16zk) there was discussion of using Github Projects for tracking issues across all of the pekko repositories and not just incubator-pekko.
Issues here:
1. I'm unsure whether this is actually happening or not since that thread did not resolve.
2. Newcomers/Non-committers can't access the GitHub project: https://github.com/orgs/apache/projects/220/views/1 since it is "Private" and would therefore be excluded from getting a high level view on project status.
TODO: Clarify the source of truth the whole-pekko 1.0.0 requirements. I would vote opening up the GitHub project OR just using the 1.0.0 milestone in incubator-pekko to track everything.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
[GitHub] [incubator-pekko] Claudenw commented on issue #112: Clearly describe current project state and how to contribute
Posted by "Claudenw (via GitHub)" <gi...@apache.org>.
Claudenw commented on issue #112:
URL: https://github.com/apache/incubator-pekko/issues/112#issuecomment-1476270267
@sam-byng , this proposal looks good. I suggest creating a pull request with the changes and a [DISCUSS] tagged message on the dev mailing list pointing to it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org