Guidelines for PRs

[knadh]

• Bug fix PRs are welcome. Please include screenshots of visual changes in the PR description. I've realised that it's been difficult to keep up with PRs (and reviewing them) and I've also been missing looking at legitimate PRs. If you find bugs, please open an issue describing them first for me to confirm, before sending a PR.
• New components and features, please open an issue first to discuss before sending a PR. I would like to keep this library minimal and compact, so new components will be added judiciously.
• A broad goal can be to keep this lib under ~10KB (forever). It could have ~90% of the most commonly and widely used components and controls, while the remaining 10%, users can bring their own.

Thank you.

[amareshsm]

Suggestion: It might be helpful to create a CONTRIBUTING.md file in the repository. Many contributors look for a contributing guide before submitting a PR—I was actually looking for one myself.

While the “Guidelines for PR” issue is useful, issues can easily get buried as new ones are created.

[rushil-b-patel]

Also if you could add a local setup guide, it would be easy to run the project locally.

[knadh]

Also if you could add a local setup guide, it would be easy to run the project locally.

@rushil-b-patel added here: https://oat.ink/usage/#local-dev-setup

[thepoetdj]

New components and features, please open an issue first to discuss before sending a PR

@knadh Would it be possible to use the GitHub Discussions board instead? Maybe you have already thought this through and might have had a good reason not to.

I've seen some projects follow that, and it does make sense (i.e. ghostty-org/ghostty#3558)

[knadh]

Hi @thepoetdj. I tried this on @knadh/listmonk but then it ended up with discussions getting scattered between Issues and Threads. I don't want to disable Issues as that's what most people are familiar with.

[varadkulk]

@knadh Issue templates can be configured as mentioned here so that issues can be structured

[prahaladhchandrahasan]

I have some changes that fixes up some typos in the codebase, any guidelines on how to make a contribution?

[knadh]

Typos, you can just send a PR.