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

[F] Fix grammar (of EditingGuide.md). #1

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Aquaticat
Copy link
Member

No description provided.

@sauricat
Copy link
Member

Thank you! The <br> grammar in markdown is not recommended. Some problems are due to our different wording habits, but I will consider your suggestion. For the gender-neutral language reference provided by the Canadian government, it is good to add to our guide.

@Aquaticat
Copy link
Member Author

So, what'd you recommend for inserting line breaks other than <br>?

Just don't insert line breaks?

Just start new paragraphs?

@Aquaticat
Copy link
Member Author

Yes, of course different people have different wording habits.
You are the maintainer, you have the final say in this.

@Aquaticat
Copy link
Member Author

I have eliminated the use of <br> tags.

More changes were made to the structure of the document.

I will share more details on what those changes are, so you can review them properly.

@Aquaticat
Copy link
Member Author

(<br> tag is allowed in this comment because I'm not editing a file that's meant for the public.)

Generally:

  1. Broke long lines in markdown into multiple lines.

1

Original:

We aim to be a small memorial rather than a wiki. Therefore, we encourage you to write to mourn those transgender friends or allies who have passed away, and to soothe those who are still alive. No matter what gender identity they were, we hope to show our readers, “they were the same as me. They are one among us.” Therefore, both overly exaggerated or overly calm descriptions need to be avoided.

Edited:

We aim to be a small memorial rather than a wiki.
Therefore, we encourage you to write to mourn those transgender friends or allies who have passed away,
and to soothe those who are still alive.
We want to show our readers: “They were the same as me. They are one among us.”, no matter which gender identity they had.
Therefore, both overly exaggerated or overly calm descriptions need to be avoided.
  1. Broke long lines into multiple lines.

  2. Changed "we hope to show" to "we want to show".

  3. Changed "what gender identity they were" to "which gender identity they had".

  4. Placed "We want to show our readers..." before "no matter which gender identity they had"

2

Original:

You have more creative freedom than contributing to a wiki, but you should still follow some fundamental principles, such as:
...

Edited:

You have some creative freedom when contributing to [One-Among.Us](https://one-among.us), but you should still follow some basic principles, such as:
  1. Changed "more creative freedom than contributing to a wiki" to "some creative freedom when contributing to One-Among.Us because it's better to focus on this project itself than comparing it to other projects.

3

Original:

- Be as truthful as possible.
- For large paragraphs of quotations, ...
- Slangs in the community can be used, ...

The article should be written in third person...

Use proper punctuation in articles...

To protect our readers, ...

Edited:

1.  Be as close to the truth as possible.

2.  Cite the source for large paragraphs of quotations.

3.  Slangs in the community might be used for simplicity, ...

4.  The article should be written in third person...

5.  Use proper punctuation.

6.  If someone left us through suicide, ...
  1. Structural change:

    Use a numbered list instead of using both an unordered list and free paragraphs for consistency.

4

Original:

Be as truthful as possible.

Edited:

Be as close to the truth as possible.
  1. Change "truthful" to "close to the truth".

5

Original:

For large paragraphs of quotations, the source needs to be indicated.

Edited:

Cite the source for large paragraphs of quotations.
  1. The main idea the sentence want to express is that "citing is needed".
    Therefore, place the action before the subject makes more sense.

6

Original:

Slangs in the community can be used, but if you like, please add a comment when they first appear.

Edited:

Slangs in the community might be used for simplicity, but do add a comment when they first appear.
  1. Using "might" instead of "can", using "might" instead of "may".

  2. State the reason to accept slang usage.

  3. Remove unnecessary "if you like".

7

Original:

The article should be written in third person. Please use proper gender pronouns in accordance with the wishes of them. For non-binary, agender or gender-non-confirming people, if they did not show their pronouns, please use “they” in English and「ta」in Chinese for there is no proper, common Chinese characters at present. Or you can use your language skills to avoid pronouns.

Edited:

4.  The article should be written in third person.
    Please use proper gender pronouns in accordance with the wishes of them.

    For non-binary, agender or gender-non-confirming people,
    use gender-neutral language.
    If they did not declare their pronouns,
    you can use your [Gender-Neutral writing](https://www.justice.gc.ca/eng/rp-pr/csj-sjc/legis-redact/legistics/p1p15.html) skills to avoid using pronouns.
    Otherwise,
    please use “they” in English and「ta」in Chinese for there is no proper, common Chinese characters at present.
  1. Broke long lines into multiple lines.

  2. Change "show" to "declare".

  3. Prefer using Gender-Neutral writing skills than using "they/them" pronouns.

8

Original:

Use proper punctuations in articles. In Chinese articles, regardless of different Chinese variants, use「」(outer) and『』(inner) for quotation marks in replace of “” or ‘’ unless the words in the quotation marks are not Chinese. Use curly quotation marks instead of straight ones.

Edited:

5.  Use proper punctuations.

    In Chinese articles, regardless of language variant, use「」(outer) and『』(inner) for quotation marks in place of “” or ‘’ unless the words in the quotation marks are not Chinese.
    Use curly quotation marks instead of straight ones.
  1. Broke long lines into multiple lines.

9

Original:

To protect our readers, if someone departed from us through suicide, please hide the detail of their methods as you can. You must not write down the name or dose of the medicine or drugs if it was an overdose or poisoning.

Edited:

6.  If someone left us through suicide, please avoid mentioning the details of their methods to protect our readers.

    For example, you must not write down the name or dose of the substance involved.
  1. Use "avoid mentioning" instead of "hide".

  2. Use "left" instead of "departed from".

  3. Use "substance" instead of "medicine or drugs".

  4. "overdose or poisoning" is an unnecessary detail in this sentence.

10

Original:

Before proceeding, you may assure yourself that you have knowledge of:
- basics of `git`: cloning repositories, making commits, rebasing a branch to the main branch, and syncing between upstream and local repositories;
- basics of GitHub: forking repositories, creating pull requests, and collaborate with other GitHub users;
- basic grammar of the YAML language: indentation rules, usage of dash, spaces, and quotes, and escaping from special characters;
- basic grammar of the Markdown language.

Edited:

Before proceeding, please confirm that you have knowledge of:
- basics of `git`: cloning repositories, making commits, rebasing a branch (to the main branch), and syncing between upstream and local repositories;
- basics of GitHub: forking repositories, creating pull requests, and other major GitHub features for collaboration;
- basic grammar of the [YAML language](https://yaml.org/): indentation rules, usage of dash, spaces, and quotes, and escaping from special characters;
- basic grammar of the [Markdown language](https://www.markdownguide.org/).
  1. Change "you may assure yourself" to "please confirm".

  2. "forking repos, creating pull requests" are a part of "collaborate with other GitHub users".

  3. Add links to YAML and Markdown.

11

Original:

Otherwise, you can simply email your writings and advices to [[email protected]](mailto:[email protected]). Our staff will transform them to the proper format. We do not assume our contributors have to master any technical skills – at any time, you can work in a more “traditional” way and your contribution will also be highly recognized.

Edited:

Otherwise, you can simply email your writings or suggestions to [[email protected]](mailto:[email protected]).
Our staff will transform them properly.
We do not believe our contributors must master any technical skills – you can work in a more “traditional” way if you like and your contributions would still be valued.
  1. Change "advices" to "suggestions" because advice cannot be plural.

  2. Change "assume ... have to" to "believe ... must".

  3. Change "at any time" to "if you like".

  4. Change "will also" to "would still".

  5. Change "highly recognized" to "valued".

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.

2 participants