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.

Sign up for GitHub

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

Jump to bottom

Feature/contributors guide #130

Merged
merged 13 commits into from
Oct 30, 2024
Merged

Feature/contributors guide #130

merged 13 commits into from
Oct 30, 2024

Conversation

izzyyhh
Copy link
Collaborator

@izzyyhh izzyyhh commented Sep 10, 2024

Description

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • [ x] 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🤖 Build
  • 🔁 CI
  • [ x] 📦 Chore
  • ⏩ Revert

@izzyyhh izzyyhh self-assigned this Sep 10, 2024
@izzyyhh izzyyhh linked an issue Sep 10, 2024 that may be closed by this pull request
Add Guide for Contributors #28
Open
@izzyyhh izzyyhh changed the base branch from main to development September 10, 2024 14:52
@izzyyhh izzyyhh force-pushed the feature/contributors-guide branch from 6b8ee0a to ff9fc09 Compare September 11, 2024 23:03
@FabianUntermoser FabianUntermoser marked this pull request as ready for review September 19, 2024 08:33
@FabianUntermoser
refactor(makefile): cleanup
e7e0ff4
@FabianUntermoser
refactor: rename compose.dev.yml to compose.prod.yml
3a27675 
The compose.dev.yml defaults to starting prebuilt containers from the development branch.
However the makefile target `dev` starts docker for local development.
I renamed the file to compose.prod.yml to better reflect that its used to run the site on remote VM
@FabianUntermoser
docs(CONTRIBUTING): simplified setup guide
126d2c1
FabianUntermoser
FabianUntermoser previously approved these changes Sep 19, 2024
View reviewed changes
Copy link
Collaborator

@FabianUntermoser FabianUntermoser left a comment

Choose a reason for hiding this comment

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

Great start @izzyyhh. I think we should merge this.

As mentioned I woud like to see further documentation on how to properly setup Strapi for basic features of this relaunch in order to be able to really start working with the application. Once documentation, automation should follow so that new developers have a working state and don't have to deal with manual steps.

@georgalis
Copy link

As a longtime vim user, thanks for all your efforts here!

I hope it is okay to drop a couple async comments:

  • the sooner the CONTRIBUTING.md file is merged to main and linked from the default README.md the better... my initial purview of this project was derailed not knowing about the branching schema. It didn't occur to me that a website_next_generation repo would require me to navigate into any particular non-default branch, and that is still not on the default readme.
  • the miro preview graphics are excellent! nice work! they remind me of the impressive project graphics management in use by neovim, worth a careful look. It is a large complex project, they use a separate repo for graphics files to avoid polluting the code repo with binaries, and the graphics are excellent breakouts of code api and component interaction.

@georgalis
Copy link

correction: s/neovim/neomutt/
https://github.com/neomutt/neomutt
https://github.com/neomutt/gfx
https://neomutt.org/
I don't have any good examples handy of how the graphics are linked from the markdown, but navigation of the gfx repo should whet your interest if you have not seen those illistrations before...

@FabianUntermoser
docs(README): link contribution guidelines
482a801 
- move developer info to CONTRIBUTING
- move miro design up in the README
@FabianUntermoser
Copy link
Collaborator

I linked the contribution guide from the README and removed some duplicate info.

Keeping the documentation / design files closer to the repo is a good point.
I don't have access to the design files, but perhaps there's a way to share the adobe XD images through a link,
which could be inlined in markdown like this ![img](copied-url). This would only work as long as the link is valid though.

I can't comment on the branch strategy, but I agree it unnecessarily hides the development efforts of this project.

@muru
Copy link

muru commented Oct 27, 2024

Is there anything blocking this PR from being merged? (Or at least, anything that random drive-by contributions by people not in the core dev team could fix?)

@izzyyhh
Copy link
Collaborator Author

izzyyhh commented Oct 28, 2024

Is there anything blocking this PR from being merged? (Or at least, anything that random drive-by contributions by people not in the core dev team could fix?)

Not really, waiting for approval. Every contribution is helpful!

@FabianUntermoser FabianUntermoser merged commit cdb1f33 into development Oct 30, 2024
3 checks passed
@FabianUntermoser FabianUntermoser deleted the feature/contributors-guide branch October 30, 2024 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FabianUntermoser FabianUntermoser Awaiting requested review from FabianUntermoser

Assignees

@izzyyhh izzyyhh

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add Guide for Contributors
4 participants
@izzyyhh @georgalis @FabianUntermoser @muru