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

Make project available as a template #5

Open
MichaelCurrin opened this issue Nov 8, 2020 · 3 comments
Open

Make project available as a template #5

MichaelCurrin opened this issue Nov 8, 2020 · 3 comments

Comments

@MichaelCurrin
Copy link

At the moment, if someone wants to use your project they will fork it and make changes for their custom site and probably never submit a PR as it serves a different purpose there.

Therefore your repo is a good candidate for the template flow. Go to your Settings and enable Use this template button. This will appear on your repo main view so anyone can generate a new project based on yours and it will add a link back to your repo.

@MichaelCurrin
Copy link
Author

One step further, you can add a Use this template button in your README. I like to so this for my projects to make it extra clear for someone to get a copy of my template and start using it.

@MichaelCurrin
Copy link
Author

MichaelCurrin commented Nov 8, 2020

Markdown:

[![Use this template](https://img.shields.io/badge/Use_this_Template-2ea44f.svg?style=for-the-badge&logo=github)](https://github.com/ashtonmv/particular/generate)

Result:

Use this template

@MichaelCurrin
Copy link
Author

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

No branches or pull requests

1 participant