search

JonasHiltl / openchangelog

Easy to configure & self hostable Changelog Website
https://openchangelog.com
GNU Affero General Public License v3.0
154 stars 9 forks source link

[Docs] Add contribution guide #6

Closed sergi0g closed 2 months ago

sergi0g commented 2 months ago

Instructions on how to contribute and set up a development environment are crucial to attract more developers on a project.

This can either be a section in the README or a CONTRIBUTING.MD at the root of the repository.

I'm not sure if I did it correctly, but the only thing that worked for me was downloading air, templ and tailwindcss.

The docs should include having to run templ generate, etc. They could also include additional steps before submitting a PR, like formatting the code.

JonasHiltl commented 2 months ago

Hi @sergi0g, I'v opened PR #10 to add a CONTRIBUTING.md file. Please have a look and let me know if you think anything is missing or could be improved. Thanks!

sergi0g commented 2 months ago

@JonasHiltl I left some comments!

JonasHiltl commented 2 months ago

@sergi0g I can't see any comments on the PR. I changed it from a draft to open PR, maybe now you can leave a review

sergi0g commented 2 months ago

@JonasHiltl sorry, I don't know how to use github reviews on mobile yet... You should be able to see them now

JonasHiltl commented 2 months ago

@sergi0g Thanks for taking the time and reviewing the PR. Feel free to open issues if you encounter any problems with Openchangelog.