Update CONTRIBUTING.md - fixing a link, wording #2795
Conversation
Excited to see this unframework framework as a long time (since 1998 coder) HTML appreciator. I wanted to learn about extensions but noticed a broken link that others might stumble upon. Consider rephrasing a question to invite a person to contribute their issue. (this can be ignored if you like).
CONTRIBUTING.md
Outdated
| @@ -3,10 +3,10 @@ Thank you for your interest in contributing! Because we're a small team, we have | |||
|
|
|||
| ## Issues | |||
| 1. Issues are the best place to propose a new feature. Keep in mind that htmx is a small library, so there are lots of great ideas that don't fit in the core; it's always best to check in about an idea before doing a bunch of work on it. | |||
| 1. When proposing a new features, we will often suggest that you implement it as an [extension](https://htmx.org/extensions), so try that first. Even if we don't end up supporting it officially, you can publish it yourself and we can link to it. | |||
| 1. When proposing a new features, we will often suggest that you implement it as an [extension](https://htmx.org/docs/#extensions), so try that first. Even if we don't end up supporting it officially, you can publish it yourself and we can link to it. | |||
There was a problem hiding this comment.
Think we forgot to update along with htmx 2 that moved extensions out of the main repo.
We probably want to directly point at the extensions repo though.
There was a problem hiding this comment.
I can change that.
CONTRIBUTING.md
Outdated
| 1. Search the issues before proposing a feature to see if it is already under discussion. Referencing existing issues is a good way to increase the priority of your own. | ||
| 1. We don't have an issue template yet, but the more detailed your description of the issue, the more quickly we'll be able to evaluate it. | ||
| 1. See an issue that you also have? Give it a reaction (and comment, if you have something to add). We note that! | ||
| 1. Do you see an issue that you have? Give it a reaction (and comment, if you have something to add). We note that! |
There was a problem hiding this comment.
Not sure about this one to be honest
- I feel dropping the "also" makes it lose a bit of its meaning/context (as we're just using the generic "issue" word here and not specifically "GitHub issue", even though that is what is implied)
- The "do you" wording may be a bit redundant/unnecessary, or at least "less direct" if that makes sense. Btw, 2 lines below we have a similar wording with "want to contribute [...] ?", which would illustrate even more what I mean if it were to be changed to match this new wording style, as there are 2 occurrences in the same sentence
There was a problem hiding this comment.
Thanks for taking the time to share your thoughts.
Perhaps you or the original author used a casual language and that's what you're preferring. I find it more direct to have a language of Do you and using reference to issues, we could clarify further Github issues.
Basically removing ambiguity and having calls for action.
I'm not married to this proposal.
There was a problem hiding this comment.
I'm not married to this proposal.
Me neither! Disclaimer: I didn't write this, and I'm not a native english speaker, this was just my personal opinion.
As for the PR itself, I would probably suggest only pushing the link fix in this one, and why not make another PR with the wording change, just so that I can merge the fix link right away, while we let the wording being discussed on its own PR
There was a problem hiding this comment.
I agree fully with the last bit. I thought of it as I was editing the doc and typical dev manner stepped into to add just one more change, haha. Thank you.
Even if you arent a native speaker, your input is still valid and appreciated.
There was a problem hiding this comment.
I just made an update patch addressing both issues. thanks
Removed change to grammar/style of writing back to original. Providing a more updated reference to extensions with greater detail.
|
Thanks! |
Excited to see this unframework framework as a long time (since 1998 coder) HTML appreciator.
I wanted to learn about extensions but noticed a broken link that others might stumble upon.
Consider rephrasing a question to invite a person to contribute their issue. (this can be ignored if you like).
Description
Please describe what changes you made, and why you feel they are necessary. Make sure to include
code examples, where applicable.
Corresponding issue:
Testing
Please explain how you tested this change manually, and, if applicable, what new tests you added. If
you're making a change to just the website, you can omit this section.
Checklist
masterfor website changes,devforsource changes)
approved via an issue
npm run test) and verified that it succeeded