Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Add a CONTRIBUTING.md #5

Open
Akshu-on-github opened this issue Dec 9, 2020 · 6 comments
Open

Add a CONTRIBUTING.md #5

Akshu-on-github opened this issue Dec 9, 2020 · 6 comments

Comments

@Akshu-on-github
Copy link
Member

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
Copy link

github-actions bot commented Dec 9, 2020

It's great having you contribute to this project

Feel free to raise an Issue! Welcome to the community 🤓

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
Copy link
Member

MallikarjunHt commented Dec 11, 2020

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.
🤓
Thank you.

@Vyvy-vi
Copy link
Member

Vyvy-vi commented Dec 11, 2020

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

@Vyvy-vi
Copy link
Member

Vyvy-vi commented Dec 11, 2020

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

@eddiejaoude
Copy link
Member

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
Copy link
Member

adityaraute commented Feb 23, 2021

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

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

No branches or pull requests

5 participants