Skip to content

Conversation

@cleptric
Copy link
Member

@cleptric cleptric commented Aug 11, 2022

This is based on our Laravel SDK CONTRIBUTING.md.

Please let me know if I should add more things or if anything in here is plain wrong.

Closes #1289

@cleptric cleptric self-assigned this Aug 11, 2022
@ste93cry
Copy link
Contributor

ste93cry commented Aug 11, 2022

I wonder if we should really enter the rabbit hole of how to install PHP, rather than just saying that it is a prerequisite for the working environment (of course)

@stayallive
Copy link
Collaborator

stayallive commented Aug 11, 2022

I agree, we shouldn't provide a step-by-step installation guide for PHP plenty of info on that on the internet, but we can give some guidance on where to get it. Maybe some inspiration can be taken from the Laravel SDK where I updated the guide few months ago:

@cleptric
Copy link
Member Author

I aligned the CONTRIBUTING.md with our Laravel SDK.
I added our branch workflow as well as a note about updating the CHANGELOG.md file.
Once this is merged, let's also update sentry-laravel and sentry-symfony.

@cleptric cleptric force-pushed the mh/CONTRIBUTING.md branch from 04de0b9 to b4f9b94 Compare August 11, 2022 21:21
Copy link
Contributor

@vladanpaunovic vladanpaunovic left a comment

Choose a reason for hiding this comment

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

I agree with above sentiments from @stayallive and @ste93cry (thanks folks!).

Other than that, this looks good. Nice addition to this repo! Thanks @cleptric! 🥳

@cleptric cleptric changed the title docs: Add CONTRIBUTING.md docs: Update README.md & add CONTRIBUTING.md Aug 12, 2022
@cleptric
Copy link
Member Author

Based on #1289, I made some changes to the README.md as well.

Copy link
Collaborator

@stayallive stayallive left a comment

Choose a reason for hiding this comment

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

Looks good, we can always keep iterating on this 😄

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.

Improve README.md and CONTRIBUTING.md

5 participants