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

Document new coding style guide #4825

Merged
merged 2 commits into from
Sep 8, 2021

Conversation

paulbalandan
Copy link
Member

Description
Start documenting the new coding style rules and conventions. Most of here are from PSR-12 with a non-exhaustive list of our "custom" rules. After this, anyone can contribute adding to the customized rules section basing upon our enforced CS.

Checklist:

  • Securely signed commits

Copy link
Member

@MGatner MGatner left a comment

Choose a reason for hiding this comment

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

This is awesome! Thanks for being so thorough. One inline comment.

contributing/styleguide.md Outdated Show resolved Hide resolved
@lonnieezell
Copy link
Member

@paulbalandan is this ready to merge?

Copy link
Member

@MGatner MGatner left a comment

Choose a reason for hiding this comment

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

Could we get a link to the repo with a very general description?

@paulbalandan
Copy link
Member Author

Could we get a link to the repo with a very general description?

I think I did not follow what you want ?

@MGatner
Copy link
Member

MGatner commented Sep 5, 2021

I would like some mention that the coding style is enforced by CS Fixer, with a link to the CodeIgniter/style-guide repo and a one-sentence introduction on what this is/does. I can suggest the change when I'm on desktop later if that would be helpful.

@kenjis
Copy link
Member

kenjis commented Sep 7, 2021

@MGatner v4.1.4 was released. Why don't you merge this for now?

@MGatner
Copy link
Member

MGatner commented Sep 8, 2021

Yes this needs to get in - I will make that addition today.

Copy link
Member

@MGatner MGatner left a comment

Choose a reason for hiding this comment

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

Feel free to emend, but this is the kind of addition I would like to see.

contributing/styleguide.md Show resolved Hide resolved
Co-authored-by: MGatner <mgatner@icloud.com>
@paulbalandan paulbalandan merged commit e023f02 into codeigniter4:develop Sep 8, 2021
@paulbalandan paulbalandan deleted the coding-style-docs branch September 8, 2021 23:44
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.

5 participants