Fix guideline page #246
Fix guideline page #246
Conversation
WalkthroughThe recent update focuses on the guidelines.md document within the community organization section, where no significant changes were made. This ensures the stability and consistency of the existing guidelines without introducing new alterations. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Out of diff range and nitpick comments (11)
content/community/organisation/guidelines.md (11)
Line range hint
51-51: Consider using a hyphen in "open source" when used as a compound adjective.- QGIS is free and open source software + QGIS is free and open-source software
Line range hint
62-62: Ensure consistent use of articles with uncountable nouns.- Examples of use requiring a permission + Examples of use requiring permission
Line range hint
65-65: Ensure consistent use of articles with uncountable nouns.- to obtain a permission. + to obtain permission.
Line range hint
69-69: Ensure consistent use of articles with uncountable nouns.- A permission is not a formal endorsement + Permission is not a formal endorsement
Line range hint
74-74: Ensure consistent use of articles with uncountable nouns.- to apply for and obtain a permission + to apply for and obtain permission
Line range hint
99-99: Add a comma after "QGIS" for better readability.- When referring to QGIS please do not undermine + When referring to QGIS, please do not undermine
Line range hint
148-148: Ensure consistent use of articles with uncountable nouns.- without a permission + without permission
Line range hint
164-164: Ensure consistent use of articles with uncountable nouns.- Do I still need a permission? + Do I still need permission?
Line range hint
172-172: Ensure consistent use of articles with uncountable nouns.- Do I need to apply for a permission? + Do I need to apply for permission?
Line range hint
174-174: Ensure consistent use of articles with uncountable nouns.- you still need a permission for the use of the word QGIS + you still need permission for the use of the word QGIS
Line range hint
181-181: Ensure consistent use of articles with uncountable nouns.- If I get a permission for my trademark + If I get permission for my trademark
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- content/community/organisation/guidelines.md (5 hunks)
Additional Context Used
LanguageTool (31)
content/community/organisation/guidelines.md (31)
Near line 20: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...does not permit all uses of QGIS Marks. QGIS.ORG has posted these Trademark Usage Gu...
Near line 29: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...country user groups, to register a QGIS Top Level Domain (qgis.ch, qgis.dk etc.) accordin...
Near line 36: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...niversity, and similar, you do not need a permission to cite QGIS name and use the logo in i...
Near line 50: Consider adding a comma here.
Context: ...t themeClass="coloring-1" >}} ##### Note Please routinely explain in your course materi...
Near line 51: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... course materials that QGIS is free and open source software, and actively encourage anyone...
Near line 62: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...roject. Examples of use requiring a permission ---------------------------------------...
Near line 65: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...ur trademark require the user to obtain a permission. If you need a permission, please fill ...
Near line 65: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...ser to obtain a permission. If you need a permission, please fill out our form ([https://goo...
Near line 69: ‘A’ may be redundant when used with the uncountable noun ‘permission’.
Context: ... themeClass="coloring-1" >}} ##### Note A permission is not a formal endorsement of your QGI...
Near line 74: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...ou are required to apply for and obtain a permission from the QGIS Project Steering Committe...
Near line 74: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...ring Committee (QGIS-PSC). This is true whether or not you apply to register your trademark wi...
Near line 78: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e credit to the QGIS project where due. Don’t hide the fact that your product is b...
Near line 99: Consider adding a comma here.
Context: ...Referring to QGIS When referring to QGIS please do not undermine the validity of the ma...
Near line 104: Consider shortening this phrase to just “whether”, or rephrase the sentence to avoid “as to”.
Context: ...misleading or likely to cause confusion as to whether the website is sponsored by or affiliat...
Near line 104: Nowadays, it’s more common to write this as one word.
Context: ... remove our mark from your domain name, web site or publication if we deem it’s use to b...
Near line 104: Did you mean “used”?
Context: ...web site or publication if we deem it’s use to be inappropriate. 1. **Com...
Near line 106: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...mercial projects cannot use a qgis.tld (top level domain)**: Any principal or secondary l...
Near line 118: ‘A’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...coloring-1" >}} ##### Referring to QGIS A permission is not a formal endorsement of QGIS pro...
Near line 124: ‘Any and all’ might be wordy. Consider a shorter alternative.
Context: ... * Social Media: Any and all use of our Marks in connection with acc...
Near line 124: Consider simply using “of” instead.
Context: ...forth herein as for other uses. The use of any of our Marks in an account name, profile n...
Near line 133: Usually, there’s no comma before “if”.
Context: ...rsement by the QGIS project or community, if the same is not true. 2. **Compan...
Near line 148: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ... or logo as part of a trademark without a permission, or if you see references to QGIS witho...
Near line 148: It appears that an object is missing here.
Context: ...them know about our trademark. We would appreciate if you could notify us through a mail t...
Near line 164: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...’s trademark authority. Do I still need a permission?_ A: Yes, assuming your trademark ...
Near line 166: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...your trademark includes the element QGIS and it is being used in connection with sof...
Near line 166: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...he permission applies to QGIS trademark whether or not they are registered with a trademark au...
Near line 166: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...are using the term QGIS as a trademark (whether or not registered), you need to apply for a pe...
Near line 166: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ... not registered), you need to apply for a permission. {{< rich-content-end >}} {{< rich-box-...
Near line 172: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...e entity’s name. Do I need to apply for a permission?_ A: Using QGIS in the entity’s na...
Near line 174: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...uses “QGIS” in its name, you still need a permission for the use of the word QGIS in the nam...
Near line 181: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...Class="coloring-1" >}} Q: _If I get a permission for my trademark, will QGIS refuse to g...
|
Can you make 'our form' to be the link and hide the long url? |
|
LGTM after comment above is addressed |
There was a problem hiding this comment.
Actionable comments posted: 4
Out of diff range and nitpick comments (1)
content/community/organisation/guidelines.md (1)
Line range hint
69-69: Remove redundant article "A" before "permission".- A permission is not a formal endorsement of your QGIS related project and doesn’t constitute a statement on the quality of your service. + Permission is not a formal endorsement of your QGIS related project and doesn’t constitute a statement on the quality of your service.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- content/community/organisation/guidelines.md (6 hunks)
Additional Context Used
LanguageTool (33)
content/community/organisation/guidelines.md (33)
Near line 20: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...does not permit all uses of QGIS Marks. QGIS.ORG has posted these Trademark Usage Gu...
Near line 29: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...country user groups, to register a QGIS Top Level Domain (qgis.ch, qgis.dk etc.) accordin...
Near line 36: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...niversity, and similar, you do not need a permission to cite QGIS name and use the logo in i...
Near line 50: Consider adding a comma here.
Context: ...t themeClass="coloring-1" >}} ##### Note Please routinely explain in your course materi...
Near line 51: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... course materials that QGIS is free and open source software, and actively encourage anyone...
Near line 62: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...roject. Examples of use requiring a permission ---------------------------------------...
Near line 65: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...ur trademark require the user to obtain a permission. If you need a permission, please fill ...
Near line 65: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...ser to obtain a permission. If you need a permission, please fill out [our form](https://goo...
Near line 69: ‘A’ may be redundant when used with the uncountable noun ‘permission’.
Context: ... themeClass="coloring-1" >}} ##### Note A permission is not a formal endorsement of your QGI...
Near line 74: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...ou are required to apply for and obtain a permission from the QGIS Project Steering Committe...
Near line 74: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...ring Committee (QGIS-PSC). This is true whether or not you apply to register your trademark wi...
Near line 78: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e credit to the QGIS project where due. Don’t hide the fact that your product is b...
Near line 99: Consider adding a comma here.
Context: ...Referring to QGIS When referring to QGIS please do not undermine the validity of the ma...
Near line 104: Consider shortening this phrase to just “whether”, or rephrase the sentence to avoid “as to”.
Context: ...misleading or likely to cause confusion as to whether the website is sponsored by or affiliat...
Near line 104: Nowadays, it’s more common to write this as one word.
Context: ... remove our mark from your domain name, web site or publication if we deem it’s use to b...
Near line 104: “It’s” is the contracted form of “it is”. Did you mean to use the possessive determiner “its”?
Context: ...ame, web site or publication if we deem it’s use to be inappropriate. 1. *...
Near line 104: Did you mean “used”?
Context: ...web site or publication if we deem it’s use to be inappropriate. 1. **Com...
Near line 106: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...mercial projects cannot use a qgis.tld (top level domain)**: Any principal or secondary l...
Near line 118: ‘A’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...coloring-1" >}} ##### Referring to QGIS A permission is not a formal endorsement of QGIS pro...
Near line 124: ‘Any and all’ might be wordy. Consider a shorter alternative.
Context: ... * Social Media: Any and all use of our Marks in connection with acc...
Near line 124: Consider simply using “of” instead.
Context: ...forth herein as for other uses. The use of any of our Marks in an account name, profile n...
Near line 133: Usually, there’s no comma before “if”.
Context: ...rsement by the QGIS project or community, if the same is not true. 2. **Compan...
Near line 137: Possible missing article found.
Context: ...e a name that is confusingly similar to QGIS trademark. If in doubt, find out!...
Near line 148: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ... or logo as part of a trademark without a permission, or if you see references to QGIS witho...
Near line 148: It appears that an object is missing here.
Context: ...them know about our trademark. We would appreciate if you could notify us through a mail t...
Near line 164: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...’s trademark authority. Do I still need a permission?_ A: Yes, assuming your trademark ...
Near line 166: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...your trademark includes the element QGIS and it is being used in connection with sof...
Near line 166: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...he permission applies to QGIS trademark whether or not they are registered with a trademark au...
Near line 166: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...are using the term QGIS as a trademark (whether or not registered), you need to apply for a pe...
Near line 166: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ... not registered), you need to apply for a permission. {{< rich-content-end >}} {{< rich-box-...
Near line 172: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...e entity’s name. Do I need to apply for a permission?_ A: Using QGIS in the entity’s na...
Near line 174: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...uses “QGIS” in its name, you still need a permission for the use of the word QGIS in the nam...
Near line 181: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...Class="coloring-1" >}} Q: _If I get a permission for my trademark, will QGIS refuse to g...
| @@ -34,6 +34,7 @@ Examples of use that do not require permission | |||
| In cases of fair use, you may use or refer to QGIS trademark without explicit permission from QGIS.ORG. The following are examples of such permitted usages: | |||
|
|
|||
| * **Books, articles, tutorials**: If you write articles, books, blog articles, tutorials, study materials for university, and similar, you do not need a permission to cite QGIS name and use the logo in it. | |||
|
|
|||
There was a problem hiding this comment.
Remove redundant article "a" for uncountable noun "permission".
- you do not need a permission to cite QGIS name and use the logo in it.
+ you do not need permission to cite QGIS name and use the logo in it.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| you do not need permission to cite QGIS name and use the logo in it. |
| @@ -43,6 +44,7 @@ | |||
|
|
|||
|
|
|||
| * **Courses, training**: If you present a course on QGIS, in either an academic, free, or commercial context, you can use the logo and the name ‘QGIS’ in course material. | |||
|
|
|||
| {{< rich-box-start icon="💭" layoutClass="tips">}} | |||
| {{< rich-content-start themeClass="coloring-1" >}} | |||
| ##### Note | |||
There was a problem hiding this comment.
Add a comma after "Note" for better readability.
- ##### Note
+ ##### Note,Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ##### Note | |
| ##### Note, |
| @@ -60,7 +62,7 @@ | |||
| Examples of use requiring a permission | |||
| --------------------------------------------------------------------------------------------------------- | |||
|
|
|||
| Some uses of our trademark require the user to obtain a permission. If you need a permission, please fill out our form ([https://goo.gl/forms/b57Rg6IyFy0FC47p2](https://goo.gl/forms/b57Rg6IyFy0FC47p2)). | |||
| Some uses of our trademark require the user to obtain a permission. If you need a permission, please fill out [our form](https://goo.gl/forms/b57Rg6IyFy0FC47p2). | |||
There was a problem hiding this comment.
Remove redundant article "a" before "permission".
- Some uses of our trademark require the user to obtain a permission.
+ Some uses of our trademark require the user to obtain permission.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Some uses of our trademark require the user to obtain a permission. If you need a permission, please fill out [our form](https://goo.gl/forms/b57Rg6IyFy0FC47p2). | |
| Some uses of our trademark require the user to obtain permission. If you need a permission, please fill out [our form](https://goo.gl/forms/b57Rg6IyFy0FC47p2). |
| @@ -109,6 +112,7 @@ | |||
| * QGIS.ORG Country voting members should use ccTLD (QGIS.ch, QGIS.dk, …) | |||
|
|
|||
| * Non-commercial projects can use qgis.xxxxx (qgis.tutorials would fall into this category if the tutorials are free) but should ask for permission before registering the domain. QGIS.ORG may register the domain and point it to the name servers provided by the requestor or instruct the requestor to do so. | |||
|
|
|||
| {{< rich-box-start icon="💭" layoutClass="tips">}} | |||
| {{< rich-content-start themeClass="coloring-1" >}} | |||
| ##### Referring to QGIS | |||
There was a problem hiding this comment.
Remove redundant article "A" before "permission".
- A permission is not a formal endorsement of QGIS project and doesn’t mean anything about quality of the service.
+ Permission is not a formal endorsement of QGIS project and doesn’t mean anything about quality of the service.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ##### Referring to QGIS | |
| ##### Referring to QGIS | |
| Permission is not a formal endorsement of QGIS project and doesn’t mean anything about quality of the service. |
This is the proposed fix for #244
Please find below the screenshot of the fix:
Summary by CodeRabbit