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

Improve Readme and Contribution Guide #208

Conversation

c0nst4ntin
Copy link
Collaborator

With this PR I aimed to overhaul the old README to be a bit more clear and up to date.
In doing so, I also updated the license document to be up to date again.

Furthermore I moved some of the contents of the README.md to a new CONTRIBUTING.md and generally added some more information.

I also added a set of Issue Templates to give some structure to this project.

With all changes I looked at prismicio/prismic-client and put my own twist on things.

@c0nst4ntin
Copy link
Collaborator Author

@angeloashmore @lihbr Hey, what do you think of this? Please let me know your Feedback. I would love to get this merged to give the package a newer and more welcoming look

@lihbr
Copy link
Member

lihbr commented Nov 1, 2024

Hi @c0nst4ntin, thank you so much for this!

I'll align with Angelo and we'll get back to you early next week at most about this. I don't think we'll have any objections against the updates, but maybe suggestions :)

@c0nst4ntin
Copy link
Collaborator Author

@lihbr Sounds great! Thank you. Maybe whilst you are talking to Angelo, could you also take a look at PR #204 & #207 and the discussion #205. We are all very unsure what the API Changes will mean for the PHP SDK

Copy link
Member

@lihbr lihbr left a comment

Choose a reason for hiding this comment

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

Excellent work! I reported some suggestions from Angelo and I on the updated documents but nothing blocking if you prefer to merge it as-is.

Thank you so much for your ongoing effort maintaining the PHP kit over time 🙇‍♀️

.github/ISSUE_TEMPALTE/question.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@lihbr
Copy link
Member

lihbr commented Nov 5, 2024

Also, we just sent something your way over to your mail address :)

@c0nst4ntin
Copy link
Collaborator Author

Excellent work! I reported some suggestions from Angelo and I on the updated documents but nothing blocking if you prefer to merge it as-is.

Thank you so much for your ongoing effort maintaining the PHP kit over time 🙇‍♀️

Thanks for the Feedback! It's really nice to hear your Feedback. I implemented most of your remarks and replied to everything. I will proceed to merge this now. If you notice anything else (or new), please just add a new comment and I'll be sure to fix it!

Also, we just sent something your way over to your mail address :)

Yes, I received the notification. Everything worked! Thank you so much, it was a really unexpected surprise!
I really appreciate you, Angelo and Prismic valuing my work!

@c0nst4ntin c0nst4ntin merged commit 4d46f8f into prismicio-community:master Nov 5, 2024
3 checks passed
@c0nst4ntin
Copy link
Collaborator Author

@lihbr The Issue Templates don't seem to have taken effect yet. Do I need to configure them through the Repository Settings, or is this just a cache thing?

Let me know if I can help you or change anything?

@lihbr
Copy link
Member

lihbr commented Nov 5, 2024

Should be good now: be7a513, folder typo 😉

@c0nst4ntin
Copy link
Collaborator Author

Thanks! 👍🏼

@c0nst4ntin c0nst4ntin added revisit-before-major Topic that should be looked at again when developing a new major version and removed revisit-before-major Topic that should be looked at again when developing a new major version labels Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants