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

WIP Verbiage revisions #2010

Merged
merged 8 commits into from
Sep 2, 2019
Merged

WIP Verbiage revisions #2010

merged 8 commits into from
Sep 2, 2019

Conversation

kydojo
Copy link
Contributor

@kydojo kydojo commented May 16, 2019

Made some simple, non-technical typo fixes and verbiage changes which I think make the project more welcoming to first-time FOSS contributors.

Updated the README a bit to make the project more inviting to new FOSS contributors.
Capitalized the file name, for consistency.
Fixed typos and made a change for consistency
Numerous updates were made to the CONTRIBUTING.md file in order to make the project more welcoming to new FOSS contributors. A number of inline links were added to facilitate learning of version control jargon.
@kydojo
Copy link
Contributor Author

kydojo commented May 16, 2019

New to open source contributions, so please let me know if I need to do something differently.

Numerous updates were made to the CONTRIBUTING.md file in order to make the project more welcoming to new FOSS contributors. A number of inline links were added to facilitate learning of version control jargon for newcomers.

Removed out-of-date reference to "phase 2".
@jim-parry
Copy link
Contributor

I appreciate making the contribution process easier for newcomers.
Originally, the contributing.md in the project root was a teaser or summary, directing the reader to the "contributing" section in the user guide. That user guide section was moved to its own folder in the project root, effectively becoming a contributor's guide document built-in to the repo instead of a separate document.
I see duplication between the two (CONTRIBUTING.md now and contributing/), with the stand-alone document becoming more comprehensive, and with material duplicated between the two.
Is there a better way to blend or exploit these?
Something that isn't as clear as it should be, IMHO, is the insistence on feature branches for contributions (part of gitflow).
The "insights" tab of the project repo has a link to https://opensource.guide/, which would be a good first read for newcomers to the contribution process. Directing readers there might save some "verbiage" on our end.
Again, appreciate what you are doing - want to make it as simple and clear as we can :)

@kydojo
Copy link
Contributor Author

kydojo commented May 17, 2019

Thanks for the valuable feedback. I will dig into this as soon as I have some time.

@lonnieezell
Copy link
Member

@kydojo Will you have a chance to make changes to this?

@kydojo
Copy link
Contributor Author

kydojo commented Jun 4, 2019

@lonnieezell Sorry, I've been pretty slammed with work, so probably not soon. Feel free to close it if you need to clean up, and I can submit again when I have time. Thanks

@jim-parry jim-parry changed the title Verbiage revisions WIP Verbiage revisions Aug 20, 2019
@lonnieezell lonnieezell merged commit b62fa0a into codeigniter4:develop Sep 2, 2019
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