EddieHubCommunity / template

Template repo with docs and GitHub Actions etc

MIT License

9 stars 11 forks source link

Add a CONTRIBUTING.md #5

Open Akshu-on-github opened 3 years ago

Akshu-on-github commented 3 years ago

If people are ready to contribute, we'll need a doc with guidelines on how to do so. Additionally, I'd suggest adding/linking a guide on how GitHub Actions work, and how to modify the same, so that those who are new have a place to get started

github-actions[bot] commented 3 years ago

It's great having you contribute to this project

Feel free to raise an Issue! Welcome to the community :nerd_face:

If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know.

MallikarjunHt commented 3 years ago

its better we have a separate repo with popular actions and docks for those actions. actions like CI/CD are not needed for all repos. :nerd_face: Thank you.

Vyvy-vi commented 3 years ago

I think we have a separate repo for actions and their docs https://github.com/EddieJaoudeCommunity/gh-action-community

Vyvy-vi commented 3 years ago

And I think imho CI/CD are needed for all repos, to streamline the working environment

eddiejaoude commented 3 years ago

Thanks all for the suggestions.

This was my current thinking:

template repo to have generic repo documentation files, where a GitHub Action will copy it over to all over repos, then those repos can have additional files for custom docs that are specific to those repos
support repo is where we will have most of our longer form documentation (help, tips, how to ...)
gh-action-commmunity are custom GitHub Actions that we will use in all our repos

How does that sound?

adityaraute commented 3 years ago

GitHub Actions or not, Contributing.md should be included in all repos and hence in the template as well.