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.

Sign up for GitHub

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

Update CONTRIBUTING.md - fixing a link, wording #2795

Merged
merged 2 commits into from
Aug 9, 2024
Merged

Update CONTRIBUTING.md - fixing a link, wording #2795

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ea7a46
Update CONTRIBUTING.md - fixing a link, wording
jeveloper Aug 6, 2024
76b30b5
Update CONTRIBUTING.md
jeveloper Aug 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can change that.

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!
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just made an update patch addressing both issues. thanks

1. If you haven't gotten any traction on an issue, feel free to bump it in the #issues-and-pull-requests channel on our Discord.
1. Want to contribute but don't know where to start? Look for issues with the "help wanted" tag.

Expand Down