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

there are tabs in files of xml dirctory which makes it not convenient… #964

Merged
merged 1 commit into from
Apr 4, 2016
Merged

Conversation

liu4480
Copy link
Contributor

@liu4480 liu4480 commented Mar 30, 2016

Low: xml: use spaces instead of tabs in schema files

@kgaillot
Copy link
Contributor

This looks fine, but please amend the commit message to be more in line with our (not very well-documented) usual style. In this case, the first line should be something like "Low: xml: use spaces instead of tabs in schema files" and the current message could be below that for more detail. In general, the first line of the commit message should be less than 80 characters for easy screen browsing.

The first word does not have strict rules, but commonly we use "Fix:" or "Feature:", or "High:" or "Low:" to indicate importance. The only real significance is that anything with "Feature:", "High:", "Fix:" or "Bug" will be considered for the release notes.

For future reference, we rarely change existing schema files. They are intended to be the definitive description of the schema at a particular point in time, so new ones can be added, but old ones are usually not changed. Formatting-only changes such as this one can be an exception.

@jnpkrn
Copy link
Contributor

jnpkrn commented Mar 30, 2016

Re formatting of the commit title (first line):
I don't know the full history behind this habbit, but can attest
to the practical value and convenience of the (possibly structured)
prefixes in the commit titles when compiling meaningful changelog
later on.
See also http://clusterlabs.org/developers.html (Developer FAQ #1).

And one correction:
Commit title should be, by git standards, no longer than 72 characters
(with prefered boundary 50 characters, which is quite often too few).

@jnpkrn
Copy link
Contributor

jnpkrn commented Mar 30, 2016

@liu4480 btw. if you are just after understanding the schema, you may
have a look at equivalent schemas that were just compacted to standalone
big files (as opposed to cross-referenced files you can observe here):
https://pagure.io/clufter/blob/master/f/formats/cib
(yep, they were reformatted as a side-effect of the compacting process).

@liu4480
Copy link
Contributor Author

liu4480 commented Mar 31, 2016

Hi, Ken and jnpkrn, thanks for your advices

@kgaillot
Copy link
Contributor

kgaillot commented Apr 1, 2016

Hi,

I'm sorry, I meant that the commit message in the git repository needs to be changed. You can use "git commit --amend" to update the commit message and then force-push it, and this request will be updated automatically. The git commit messages are used to build the change log for each new release.

there are tabs in files of xml dirctory which makes it not convenient to read when tab is
not eight in some vimrc, this patch replaced tabs with 8 blanks
@liu4480
Copy link
Contributor Author

liu4480 commented Apr 2, 2016

Hi, Ken
Sorry for the misunderstand, the commit message has been updated.

@kgaillot
Copy link
Contributor

kgaillot commented Apr 4, 2016

Thanks!

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