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

Some Minor Updates #11

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open

Some Minor Updates #11

wants to merge 26 commits into from

Conversation

bappi
Copy link

@bappi bappi commented Feb 13, 2017

Removing periods from file headers, as described in wp guidelines (approved in _s too) and fixing some minor things.

@metodiew
Copy link
Contributor

hey @B-07 thanks for the pull request. I wasn't following the last a few theme review meetings and I couldn't find the new requirement. Would you please share it here? Thanks in advance!

@bappi
Copy link
Author

bappi commented Feb 13, 2017

There should be no period for file headers' summary as per the WP PHP Documentation standards.

@metodiew
Copy link
Contributor

Okay, if we say we are using Summary, that's fine. We can accept that. However, I don't believe we have a decent summary and description of these files/functions, which is something we can work on in the future.
Personally, I'd go with one commit which is updating all files, instead of ~30 commits for each file for small change like this.

However, thanks for your contribution! We are happy to accept more pull requests in the future, so feel free to suggest other improvements.

I'll ask @xavortm, one of the maintainers of the starter theme, who's gonna provide more feedback.

@@ -33,7 +33,7 @@
'<span>' . get_the_title() . '</span>'
);
?>
</h2>
</h2><!-- .comments-title -->
Copy link
Contributor

Choose a reason for hiding this comment

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

I am using emmet for writing the HTML markup. These and comments are added automatically through it's filters. In this case exactly we are not adding end comments - that being the line HTML elements. You can see more about this in here - http://docs.emmet.io/filters/ and in here https://github.com/sergeche/emmet-sublime/issues/225

It's okay to leave it as it is for now, but do not add more like this one in the future as the whole theme is full of such elements and if we add just for one it will less systematic.


/**
* Sample implementation of the Custom Header feature.
* Sample implementation of the Custom Header feature
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you delete this because of the highlighting in GitHub? If that's the case there's no need to remove it since it will be of help for some of the developers for quick access to working snippet. Can you please revert this before we merge the PR?

@xavortm
Copy link
Contributor

xavortm commented Feb 13, 2017

Hey @B-07 I did leave you a few comments, please take a look at them and if fixed we will merge the PR. As Stanko mentioned, please try to keep such changes like changing comments in the same commit, it's easier to keep track of. If you work on a couple o bigger changes it's fully understandable to separate them in different commits, but this is not the case. Anyway, I am very happy that you took your time to work on our project, your PR did make me smile when I saw it!

Cheers mate, we are waiting for updates :)

@bappi
Copy link
Author

bappi commented Feb 13, 2017

@xavortm Thank you :) yes I know it's not best practice to use several commits on one issue, but I didn't think I would find so many of them :)

Anyways, I changed files as you said. Cheers!

@bappi
Copy link
Author

bappi commented Mar 17, 2017

@xavortm @metodiew Hi, I'm working on making all changes within single commit. I have a question, please help me here. I also use tabs for indentation, and in sublime I set 1tab = 4 spaces. But in github it shows 8 spaces. I notices in your files it shows 4 spaces. Can you please tell me how to do that? Much appreciated :)

@xavortm
Copy link
Contributor

xavortm commented Mar 21, 2017

Most likely this comes from 4 spaces (not tabs). We still have to get this standardization across all files set properly, but that's a todo for another day :) Don't worry about it, use regular tabs. GitHub's tabs are set by default to 8, you can't edit that.

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