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

Add more example content for good software development practice #5

Open
4 of 12 tasks
jonrkarr opened this issue Sep 9, 2021 · 3 comments
Open
4 of 12 tasks

Comments

@jonrkarr
Copy link
Member

jonrkarr commented Sep 9, 2021

Builds on @bilalshaikh42's suggestions:

  • GitHub actions
    • Semantic versioning and automated release notes
    • Static code analysis (e.g., OSSAR)
    • Dependency management (whitesource)
    • Spell checking
    • Sensitive data (GitGuardian)
    • Semantic commits (amannn/action-semantic-pull-request)
    • Format source code
  • Citation file
  • GitHub issue template
  • GitHub PR template
  • GOVERNANCE.md
@jonrkarr
Copy link
Member Author

jonrkarr commented Sep 9, 2021

While this would be helpful for some, we should keep in mind that a large template repo with many files can appear intimidating. It makes it appear like developers need to create a large amount of content, when in fact much of the files just required replace a few placeholders with the name of the simulation tool, list of developers, URL for home page, etc.

We could consider having a second, more minimal template, with just the required content without extra recommendations.

@bilalshaikh42
Copy link
Contributor

We can also use this tool to generate files for users based on simple CLI questions
https://github.com/copier-org/copier/

@jonrkarr
Copy link
Member Author

jonrkarr commented Sep 9, 2021

That's a nice suggestion.

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

No branches or pull requests

2 participants