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

Update CONTRIBUTING.md for clarity and readability #613

Merged
merged 7 commits into from
Jan 25, 2022

Conversation

acicovic
Copy link
Collaborator

Description

This PR started as a quick fix for a few CONTRIBUTING.md phrase improvement suggestions that were made in #608. However, it has evolved to a small restructure of the CONTRIBUTING.md file, as well as a minimal rewrite of some sections so they can make more sense between them.

Motivation and Context

As the newest contributor in the team and my relative inexperience with all the tooling, I've tried to update CONTRIBUTING.md in a way that is more easy to undertand and follow.

@acicovic acicovic self-assigned this Jan 24, 2022
@acicovic acicovic added this to the 3.2.0 milestone Jan 24, 2022
@acicovic acicovic marked this pull request as ready for review January 25, 2022 09:00
@acicovic acicovic requested a review from a team as a code owner January 25, 2022 09:00
Copy link
Contributor

@GaryJones GaryJones left a comment

Choose a reason for hiding this comment

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

One tiny fix, then all good.

Copy link
Contributor

@pauarge pauarge left a comment

Choose a reason for hiding this comment

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

Left some small suggestions

acicovic and others added 2 commits January 25, 2022 11:43
Co-authored-by: Pau Argelaguet <[email protected]>
Co-authored-by: Pau Argelaguet <[email protected]>
@acicovic
Copy link
Collaborator Author

The masterpiece is complete (for now).

Copy link
Contributor

@pauarge pauarge left a comment

Choose a reason for hiding this comment

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

LGTM

@acicovic acicovic merged commit 296e92f into develop Jan 25, 2022
@acicovic acicovic deleted the update/contributing-md branch January 25, 2022 14:33
pauarge pushed a commit that referenced this pull request Feb 22, 2022
Update CONTRIBUTING.md for clarity and readability
pauarge added a commit that referenced this pull request Feb 24, 2022
* Not installing env globally (#665)

* Fixing some type inconsistencies suggested by PHPStan (#657)

* Fixing some PHPStan issues

* Adding post_author check

* Adding null check

* Update src/class-rest.php

Co-authored-by: Gary Jones <[email protected]>

* Undo rest changes

Co-authored-by: Gary Jones <[email protected]>

* Merge pull request #676 from Parsely/update/improve-function-comments

Update some outdated references in function comments

* Merge pull request #620 from Parsely/fix/unhardcode-references-to-uncategorized

Un-hard code references to Uncategorized

* Exclude some files & dirs from exported plugin archives (#612)

* README.md: Change "meta data" to "metadata" (#614)

* Adding help for local development issues (#616)

* Merge pull request #613 from Parsely/update/contributing-md

Update CONTRIBUTING.md for clarity and readability

* Merge pull request #619 from Parsely/add/windows-md

Add a WINDOWS.md file for Windows developers

* Merge pull request #654 from Parsely/update/improve-docs

Improve documentation

* Minor additions to the contributing file (#683)

* Don't return metadata on REST if no API key (#688)

* Not returning metadata if no API Key

* Adding no api key test

* Add Admin Bar filter (#691)

* Adding admin bar filter

* Adding filter test

* Version bump and changelog

* Update CONTRIBUTING.md

Co-authored-by: Alex Cicovic <[email protected]>

* Addressing PR feedback

* Fix generating URL for invalid permalinks (#698)

* Fix generating URL for invalid permalinks

* Stricter type check

* Updating changelog

Co-authored-by: Gary Jones <[email protected]>
Co-authored-by: Alex Cicovic <[email protected]>
Co-authored-by: Jeff Bowen <[email protected]>
@pauarge pauarge modified the milestones: 3.2.0, 3.1.2 Feb 25, 2022
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.

3 participants