search

inclusivenaming / org

Pre-release organization info, meeting notes, collaboration, etc.
43 stars 9 forks source link

Issue / PR templates #49

Open justaugustus opened 3 years ago

justaugustus commented 3 years ago

We need issue and PR templates!

Nytelife26 commented 3 years ago

I can write these up, as I already have done for some other projects like undici. What types of issue and pull request should these encompass?

richsalz commented 3 years ago

As discussed at the last INI meeting, I agreed to do a first draft. Please take a look at https://github.com/richsalz/messing-around/issues/new/choose and play around. Put feedback here.

Nytelife26 commented 3 years ago

@richsalz the grammar on the website template is off and the second section should contain a description of the problem, not what should be done.

richsalz commented 3 years ago

Fixed, thanks @Nytelife26 (guess that second shot this morning did have an affect :)

**If you know the URL, please paste it here**
If you don't know the URL, please describe the page so we can
find it.

**What is the issue?**
What did you find that was wrong?
A clear and concise description of what you want to happen.

**Do you have a suggestion on how to fix this?**
If so, please describe it here.
Nytelife26 commented 3 years ago

@richsalz Obviously this is not exactly required but I feel it would help to clarify the process for suggesting linguistic changes to INI documents. This is the template we use to get community translations for KCS projects:

Translation template ``` **I am translating:** "" **Which is located at:** **For this language:** **Which corresponds to:** "" ```

Applied to the INI, this would look something like:

**The phrasing I found was:** "<the sentence you are suggesting a change for>"
**Which is located at:** <link to the page it is on, and preferably the section too>
**And my suggestion is:** <your suggested changes>
**Which resolves:** <the reasoning behind your changes>
richsalz commented 3 years ago

I like that change (but I'd change "which resolves" to "reason for the suggestion") but which template where you thinking of? All?

Nytelife26 commented 3 years ago

but which template where you thinking of?

The one for linguistic changes, titled "Suggest wording changes".

richsalz commented 3 years ago

The one for linguistic changes, titled "Suggest wording changes".

thanks, done!