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

README.md: remove section Related Projects #21063

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

waehlisch
Copy link
Member

@waehlisch waehlisch commented Dec 4, 2024

Whether PR #21052 should have been merged is debatable. The discussion of other PRs that try to improve PR #21052 may take some time. Instead of including content in the README.md, one very important entry point for interested RIOT users, that might conflict with rough consensus, I suggest to remove until we converged on what should be placed in the README (and how).

@waehlisch waehlisch requested a review from jia200x as a code owner December 4, 2024 01:18
@github-actions github-actions bot added the Area: doc Area: Documentation label Dec 4, 2024
@aabadie
Copy link
Contributor

aabadie commented Dec 4, 2024

I allowed myself to fix the mentioned PR number. Why not use git revert instead of manually editing the file?

Copy link
Member

@maribu maribu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK

@maribu
Copy link
Member

maribu commented Dec 4, 2024

To elaborate a bit on my NACK:

This PR does three things:

  1. Remove the section header "Related Projects"
  2. Remove all references to projects that are not part of the larger RIOT community
  3. Remove the reference to Ariel OS

A rough consensus on having a reference to Ariel OS has been established. Any PR that drops it without establishing a new rough consensus to replace the existing one is in direct violation of our self imposed rules.

If you update the PR to keep the reference to Ariel OS, I'll dismiss my NACK.

@kfessel
Copy link
Contributor

kfessel commented Dec 4, 2024

This is currently missing ": " in title and commit

https://github.com/RIOT-OS/RIOT/blob/master/CONTRIBUTING.md#commit-conventions

@waehlisch waehlisch force-pushed the remove_related_projects branch from 65f440b to b7f3a58 Compare December 4, 2024 17:58
@waehlisch waehlisch changed the title remove section Related Projects README.md: remove section Related Projects Dec 4, 2024
@OlegHahm
Copy link
Member

OlegHahm commented Dec 4, 2024

+1 for removing the other projects (at least unless we have defined which makes a project "worthy" to be listed here).
-1 for removing the reference to Ariel OS.

@waehlisch
Copy link
Member Author

waehlisch commented Dec 5, 2024

maybe someone can explain what the purpose of the README in the RIOT repository is and why Ariel should be mentioned there. otherwise it will be hard to find a solution to handle this topic.

@maribu
Copy link
Member

maribu commented Dec 5, 2024

@waehlisch it appears that you have personal issues with Ariel OS and/or the people behind it.

The RIOT community (maybe with the exception of you and @tcschmidt personally) has worked together with the people behind Ariel OS for years constructively. That work was productive and fun. Given the feedback and messages exchanged in the last week, it appears that the RIOT community and the Ariel OS community (which, to a large degree overlap) would like to continue to work constructively together.

A single sentence reference to in our README way down (I have to scroll a whole screen on my setup) isn't exactly a big deal. It a small gesture and a sign of respect. Something that I personally feel - and judging from the messages and interactions I have witnessed in the past matches what the RIOT community also feels - is well aligned with our core values of a friendly and welcoming community that strives to innovate by collaboration.

Maybe it is time to let it go and instead work together constructively?

@Teufelchen1
Copy link
Contributor

@waehlisch would it ease your pain if the Related Projects section would be:

  1. at the end of the README? That's where I would put it (and where I would search for it in other projects).
  2. we haven actual reasoning for which projects we list there
  3. highlight the actual important differences to RIOT

For me, the section should help users answering the question: "Is RIOT for me?" (or does it suit my use case) - a few other projects to compare against will help with that. In addition, it's good to be humble once in a while and RIOT is neither the only OS nor the "measurably best" - acknowledging the competition is polite and becomes imo part of the good tone of modern FOSS communities.

(Naturally, I would describe Ariel OS differently, as the current description does not help answering said question, but that's a topic for a different discussion)

@OlegHahm
Copy link
Member

OlegHahm commented Dec 5, 2024

For me, the section should help users answering the question: "Is RIOT for me?" (or does it suit my use case) - a few other projects to compare against will help with that.

I'm not quite sure how this may help. Are you assuming that a potential user may already know one of the other OS' and so it would help to understand what type of OS RIOT is? (E.g., a hypothetical user already worked with Zephyr before and would now understand that RIOT falls into the same category.)

Or do you assume this user wouldn't have heard about these other OS' before and may jump there if they come to the conclusion that the other matches their needs better? I guess that would only work if the description text already gives the user enough relevant information to judge or if we can link to a README or similar of said project that the user can compare to our README and its feature list.

@waehlisch
Copy link
Member Author

@waehlisch it appears that you have personal issues with Ariel OS and/or the people behind it.

i do want things correctly stated. this is why i raised the questions above. if the purpose of the README remains unclear, you cannot come up with a proper solution.

A single sentence reference to in our README way down (I have to scroll a whole screen on my setup) isn't exactly a big deal.

it is if the sentence is incorrect or misplaced.

Maybe it is time to let it go and instead work together constructively?

working constructively means discussions and clarifications.

@waehlisch
Copy link
Member Author

@Teufelchen1 thanks!

@waehlisch would it ease your pain if the Related Projects section would be:

  1. at the end of the README? That's where I would put it (and where I would search for it in other projects).

if we want to include a longer list, yes.

if the content is about giving an example that RIOT welcomes collaboration and inspires others, i would suggest to add a Subsection "Collaboration" in the Section Community, and add a sentence similar to "RIOT closely collaborates with and inspires other open source projects, e.g., Ariel OS, an IoT OS written in Rust. We are more than happy to collaborate with those who share our vision."

For me, the section should help users answering the question: "Is RIOT for me?" (or does it suit my use case) - a few other projects to compare against will help with that.

i'm still wondering whether this really belongs to a README file. intuitively, i would expect such discussions on web page that is part of the riot-os.org.

@kfessel
Copy link
Contributor

kfessel commented Dec 9, 2024

@waehlisch: I like your the suggestion in your recent comment -community and shared vison-, would you like to change your PR?

@waehlisch
Copy link
Member Author

@waehlisch: I like your the suggestion in your recent comment -community and shared vison-, would you like to change your PR?

if there are no objections, yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants