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.

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

Missing documentation on how to contribute #312

Open
dSyncro opened this issue Sep 4, 2024 · 2 comments
Open

Missing documentation on how to contribute #312

dSyncro opened this issue Sep 4, 2024 · 2 comments

Comments

@dSyncro
Copy link

dSyncro commented Sep 4, 2024

The title says is all. I really like this theme and while using and exploring it I found myself to often make changes to the core logic.

I thought it would be fair to give some effort back to the development of the project instead of only keeping it locally but I am struggling to find documentation on development side.

As a suggestion, I think that with minimal effort this project could integrate:

  • A CONTRIBUTING.md file with proper information on how to contribute in an appropriate way
  • An issue template
  • A PR template
  • A roadmap or something like that to pick workable items from (feature to implement, enhancements, bug fixes...)
@g1eny0ung
Copy link
Owner

Hi @dSyncro, Thanks for the advice. Yes, there is no CONTRIBUTING.md because this project starts with my personal needs. I didn't think about it that much. I can add it in my spare time to describe the structure of the repo, in particular, some are not already described in the Hugo documentation.

For issue/pr templates, they're good practices for projects, and I'd go ahead and add them first.

And roadmap, I don't have much of a plan at the moment, right now I'm more just doing whatever comes to mind. 🤪 But I'm open to suggestions, like integrating comment systems, web analysis, etc. If you have any suggestions, you can wait until I've written the feature request issue template and then make them.

@g1eny0ung
Copy link
Owner

Issue templates have been added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants