Skip to content

Enhancement: Add CONTRIBUTING.md #615

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

Merged
merged 1 commit into from
Jul 8, 2022

Conversation

localheinz
Copy link
Contributor

@localheinz localheinz force-pushed the feature/contributing branch 2 times, most recently from f053207 to f63017a Compare July 5, 2022 12:32
@localheinz localheinz force-pushed the feature/contributing branch from f63017a to 533908c Compare July 5, 2022 12:43
@cmb69
Copy link
Member

cmb69 commented Jul 5, 2022

Thank you! This is certainly a good start, but what about:

  • Steps for creating good issues or pull requests.
  • Links to external documentation, mailing lists, or a code of conduct.
  • Community and behavioral expectations.

I think at least the first item should be addressed right away.

@localheinz
Copy link
Contributor Author

@localheinz
Copy link
Contributor Author

@kamil-tekiela
Copy link
Member

It would be good to have a guide similar to https://github.com/php/php-src/blob/master/CONTRIBUTING.md but shorter.

@cmb69
Copy link
Member

cmb69 commented Jul 5, 2022

Issue templates might be useful, but some more general info (like in php-src's CONTRIBUTING.md as @kamil-tekiela pointed out) should be good for now.

Regarding a CoC: IIRC that was discussed quite a while ago for php-src, but went nowhere. I'm afraid the situation would be the same for web-php.

@localheinz localheinz force-pushed the feature/contributing branch from 533908c to b79dccc Compare July 8, 2022 12:00
@localheinz
Copy link
Contributor Author

@cmb69 @kamil-tekiela

Updated CONTRIBUTING.md based on CONTRIBUTING.md of php/php-src!

@localheinz localheinz mentioned this pull request Jul 8, 2022
1 task
- Run

```
php tests/run-tests.php -q --show-diff
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also see #621.

5. Test your changes before committing them. We mean it. Really. To do so use

```
php tests/run-tests.php -q --show-diff`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also see #621.

Copy link
Member

@cmb69 cmb69 left a comment

Choose a reason for hiding this comment

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

Thank you! Much better, in my opinion, but still a few tweaks could be applied.

Co-authored-by: Andreas MΓΆller <[email protected]>
Co-authored-by: Christoph M. Becker <[email protected]>
@localheinz localheinz force-pushed the feature/contributing branch from ad07c94 to cc4ce07 Compare July 8, 2022 20:37
@localheinz
Copy link
Contributor Author

@cmb69 @kamil-tekiela

Adjusted!

@cmb69 cmb69 merged commit 83ef234 into php:master Jul 8, 2022
@cmb69
Copy link
Member

cmb69 commented Jul 8, 2022

Thank you, @localheinz! Wrt. #621, we can adjust CONTRIBUTING.md later.

@localheinz localheinz deleted the feature/contributing branch July 8, 2022 21:33
@localheinz
Copy link
Contributor Author

Thank you, @cmb69 and @kamil-tekiela!

@localheinz localheinz mentioned this pull request Jul 8, 2022
1 task
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.

3 participants