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

Jump to bottom

Improve the CONTRIBUTING.md documentation #476

Open
germainlefebvre4 opened this issue Mar 27, 2023 · 1 comment
Open

Improve the CONTRIBUTING.md documentation #476

germainlefebvre4 opened this issue Mar 27, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@germainlefebvre4
Copy link
Contributor

I have experienced contributing on my own and faced some difficulties to onboard to non-learned sections.

Suggestions to help generation and templating:

  • Add commands to run to generate and test readme template
  • Add commands to run to generate and test hugo template

Suggestions to help to test:

  • Add unit test (pytest + lint) to ensure generation is well formatted
@xoxys
Copy link
Member

xoxys commented Mar 27, 2023

Fully agree. Will try to improve it.

@xoxys xoxys added the documentation Improvements or additions to documentation label Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@xoxys @germainlefebvre4