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

Merging the two projects #1

Closed
remkus opened this issue Jan 21, 2013 · 4 comments
Closed

Merging the two projects #1

remkus opened this issue Jan 21, 2013 · 4 comments

Comments

@remkus
Copy link

remkus commented Jan 21, 2013

Hi Justin,

When I searched for a Genesis Sublime Text repo I had missed this one and therefor started one myself: https://github.com/defries/Sublime-Text-WordPress-Genesis-Snippets

I'd really like to merge what I've done with your repo, but I have a few changes and different approaches I'd like to discus with you. The most important ones being the adhering of WordPress coding standards and having some file and folder structures like you can see done on my repo.

I'd love to hear your thoughts.

Cheers,
Remkus

@jtallant
Copy link
Owner

Remkus,

Thanks for getting in touch. I love the completions.

You mentioned WordPress coding standards. I see that certain snippets of mine do not adhere to the standards when it comes to minor things such as spacing around function params. If you fork my repo and apply your changes (as described below), I will merge it and edit my snippets to ensure they all adhere to wp coding standards.

The only issue I have is with the general WordPress snippets. I'd like to keep this repo specific to Genesis. There are other sublime packages for WordPress snippets and I like to keep the two separate.

If we merged these two repos I would prefer the following result...

Two directories - "snippets" and "completions"
Remove the WordPress directory
Put all of my snippets along with yours under the snippets folder

After you submit the pull request I will edit my snippets to make sure they all adhere to WP coding standards.

Let me know what you think.

@remkus
Copy link
Author

remkus commented Jan 21, 2013

That's exactly how I see it. I already contributed to the general WordPress snippet project here on Github and I planned to move out the WordPress snippets out of my project. So we're good :) Would be lovely if we could add proper DocBlocks to the functions instead of just the spacing, you know, set an example. More info here: http://remkusdevries.com/when-sharing-wordpress-related-code-snippets-i-can-haz-standards-please/

Might not get it done this week, since I'm getting ready to go to and speak at WordCamp Norway, but you'll see a proper pull request from me real soon :)

@jtallant
Copy link
Owner

I will add DocBlocks to my snippets. I'd prefer leaving out things like @author and @link. If it does not help the reader understand the function then they probably don't want it in their code. @link would be ok if the function requires an explanation and the uri provides one beyond another copy of the function source code.

@remkus
Copy link
Author

remkus commented Jan 22, 2013

@author in this case perhaps only makes sense if it is concerning a function written by someone else and thus has the copyright. Most likely in that case the @link will be needed as well..

On Tuesday, 22 January, 2013 at 04:48 , Justin Tallant wrote:

I will add DocBlocks to my snippets. I'd prefer leaving out things like @author (https://github.com/author) and @link (https://github.com/link). If it does not help the reader understand the function then they probably don't want it in their code. @link (https://github.com/link) would be ok if the function requires an explanation and the uri provides one beyond another copy of the function source code.


Reply to this email directly or view it on GitHub (#1 (comment)).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants