Skip to content

Conversation

@maxnorm
Copy link
Collaborator

@maxnorm maxnorm commented Oct 21, 2025

Restructures the project documentation to better separate user-facing information from contributor-focused details.

Changes

README.md

  • Added table of content
  • Reduced from 8 detailed sections to concise bullet points with references to CONTRIBUTING.md
  • Brief overview with reference to CONTRIBUTING.md for complete details
  • Essential commands only (build, test, format) with reference to CONTRIBUTING.md

CONTRIBUTING.md

  • Complete detailed explanations, examples, and philosophical context
  • All 7 detailed design principles with full explanations and examples like in the README before.
  • Detailed usage examples, test options, and help commands

Related issue:

@mudgen
Copy link
Contributor

mudgen commented Oct 21, 2025

@maxnorm This is a pretty great change. I like it a lot. I made a couple comments. Please address my comments and let's get this merged. 🚀

@mudgen
Copy link
Contributor

mudgen commented Oct 21, 2025

Should also mention that we are using Github's dicussions to discuss things, ideas etc. Also questions can be asked in discussions. It is a forum for the project.

Issues are for actions to be taken. Discussions are for general communication and discussing things, talking about possibilities and ideas etc.

@maxnorm
Copy link
Collaborator Author

maxnorm commented Oct 21, 2025

@mudgen It's now adjust based on your reviews.

@maxnorm maxnorm requested a review from mudgen October 21, 2025 12:40
@maxnorm maxnorm marked this pull request as ready for review October 21, 2025 12:45
@mudgen mudgen merged commit cea3d91 into Perfect-Abstractions:main Oct 21, 2025
1 check passed
@mudgen
Copy link
Contributor

mudgen commented Oct 21, 2025

Thanks!

JackieXu pushed a commit to JackieXu/Compose that referenced this pull request Nov 6, 2025
Improve & simplify readme & Add contributing file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants