local-it/mitgliederverwaltung
2
3
Fork 0
Code Issues 51 Pull requests 13 Projects 1 Releases Packages 1 Activity Actions

polish README closes #158 #178

Merged
simon merged 7 commits from feature/#158-polish-README into main 2025-10-16 12:05:42 +02:00
Conversation 2 Commits 7 Files changed 2 +859 -7
simon commented 2025-10-02 15:35:12 +02:00
Owner
Copy link

Generated a new polished README by running analyzation over the repository.

up for discussion:

  • Do we want a Screenshot/Mockup in there?
  • Do we need already need Logo?
  • License? see #150
  • to much information?

what do you think?

Generated a new polished README by running analyzation over the repository. up for discussion: - [ ] Do we want a Screenshot/Mockup in there? - [x] Do we need already need Logo? - [x] License? see #150 - [ ] to much information? what do you think?
simon added 2 commits 2025-10-02 15:35:13 +02:00
docs: polish readme
Some checks failed
continuous-integration/drone/push Build is failing
Details
fc4dcc3a6c
docs: reduce horizontal lines
Some checks failed
continuous-integration/drone/push Build is failing
Details
306734bcee
requested reviews from moritz, carla, rafael 2025-10-02 15:35:26 +02:00
simon added 1 commit 2025-10-02 15:38:11 +02:00
docs: add CI link
Some checks failed
continuous-integration/drone/push Build is failing
Details
7bedaff145
simon added 1 commit 2025-10-02 15:40:33 +02:00
fix CI badge
Some checks failed
continuous-integration/drone/push Build is failing
Details
b132641753
simon added 1 commit 2025-10-02 17:12:19 +02:00
feat: add license closes #150
Some checks failed
continuous-integration/drone/push Build is failing
Details
bb0fc0a627
moritz reviewed 2025-10-09 12:35:53 +02:00
README.md Outdated
@ -4,0 +107,4 @@
# Inside the repo folder:
mix local.hex 2.1.1
mix archive.install hex phx_new 1.7.20
moritz commented 2025-10-09 12:35:53 +02:00
Owner
Copy link

We use phoenix 1.8 now

We use phoenix 1.8 now
rafael commented 2025-10-16 11:45:24 +02:00
Collaborator
Copy link

I think we could even leave out the versions here completely and just assume the newest version of hex should work 🤔

I think we could even leave out the versions here completely and just assume the newest version of hex should work 🤔
simon marked this conversation as resolved
simon changed title from WIP: polish README to WIP: polish README closes #158 2025-10-09 12:59:56 +02:00
rafael approved these changes 2025-10-16 11:43:28 +02:00
rafael left a comment
Collaborator
Copy link

Great work! It's a good overview of the important things you'd want to know, both as a potential user and as a developer. I've added a few ideas here and there, but from my point of view this can be merged once you feel like it's ready.

Great work! It's a good overview of the important things you'd want to know, both as a potential user and as a developer. I've added a few ideas here and there, but from my point of view this can be merged once you feel like it's ready.
README.md Outdated
@ -4,0 +27,4 @@
* **Simple**: Focused on what clubs really need — members, dues, communication.
* **Usable**: Clean, accessible UI, GDPR-compliant, designed with everyday volunteers in mind.
* **Flexible**: Custom fields, role-based permissions, and self-service for members.
rafael commented 2025-10-16 11:35:37 +02:00
Collaborator
Copy link

I'm not sure if everyone reading this will know what "Custom fields" means. Maybe we could say something like

Customize what data you collect about members

or

Customizable forms: only collect the member data you truly need

I'm not sure if everyone reading this will know what "Custom fields" means. Maybe we could say something like > Customize what data you collect about members or > Customizable forms: only collect the member data you truly need
simon marked this conversation as resolved
README.md
@ -4,0 +58,4 @@
- Tested with: `asdf 0.16.5`
- Required versions are documented in `.tool-versions` in this repo
<details>
rafael commented 2025-10-16 11:38:44 +02:00
Collaborator
Copy link

Using the details element is a nice touch! We should be aware that it has some accessibility limitations. I think for the README it's fine though, since folks can easily read the source instead of the rendered variant :)

Using the details element is a nice touch! We should be aware that [it has some accessibility limitations](https://www.scottohara.me/blog/2022/09/12/details-summary.html). I think for the README it's fine though, since folks can easily read the source instead of the rendered variant :)
README.md Outdated
@ -19,0 +161,4 @@
## 🏗️ Architecture
- **Backend:** Elixir, Phoenix 1.8, LiveView 1.1, Ash Framework
rafael commented 2025-10-16 11:42:50 +02:00
Collaborator
Copy link

I think we could leave out the versions here, they don't add much relevant information and will become outdated quickly.

I think we could leave out the versions here, they don't add much relevant information and will become outdated quickly.
simon marked this conversation as resolved
README.md Outdated
@ -19,0 +162,4 @@
## 🏗️ Architecture
- **Backend:** Elixir, Phoenix 1.8, LiveView 1.1, Ash Framework
- **Frontend:** Phoenix LiveView + TailwindCSS + Heroicons
rafael commented 2025-10-16 11:42:21 +02:00
Collaborator
Copy link

I'd say DaisyUI instead of tailwind here, it's what you'll typically interact with most as a developer :)

I'd say DaisyUI instead of tailwind here, it's what you'll typically interact with most as a developer :)
simon marked this conversation as resolved
README.md
@ -19,0 +194,4 @@
We welcome contributions!
- Open issues and PRs in this repo.
- Please follow existing code style and conventions.
rafael commented 2025-10-16 11:41:12 +02:00
Collaborator
Copy link

Idea for the future: We could add a CONTRIBUTING.md file that documents the code style and conventions we follow.

Idea for the future: We could add a `CONTRIBUTING.md` file that documents the code style and conventions we follow.
simon added 1 commit 2025-10-16 12:00:00 +02:00
docs: polish Readme
Some checks failed
continuous-integration/drone/push Build is failing
Details
30c3943884
simon added 1 commit 2025-10-16 12:05:10 +02:00
Merge branch 'main' into feature/#158-polish-README
Some checks failed
continuous-integration/drone/push Build is failing
Details
8b72235ab3
simon changed title from WIP: polish README closes #158 to polish README closes #158 2025-10-16 12:05:15 +02:00
simon merged commit e880fb3c29 into main 2025-10-16 12:05:42 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
moritz
carla
rafael
Labels
Clear labels   
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
help wanted

Need some help

  
high priority

   
invalid

Something is wrong

  
L

5 h

  
low priority

   
M

3 h

  
medium priority

   
needs refinement

   
question

More information is needed

  
S

1 h

  
UX research

   
wontfix

This won't be fixed

No labels
bug
duplicate
enhancement
help wanted
high priority
invalid
L
low priority
M
medium priority
needs refinement
question
S
UX research
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: local-it/mitgliederverwaltung#178
No description provided.
Delete branch "feature/#158-polish-README"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?