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 a Contributing Guidelines file to the Repo #5258

Closed
Prathamesh-Shanbhag opened this issue Aug 18, 2021 · 5 comments
Closed

Add a Contributing Guidelines file to the Repo #5258

Prathamesh-Shanbhag opened this issue Aug 18, 2021 · 5 comments

Comments

@Prathamesh-Shanbhag
Copy link

Prathamesh-Shanbhag commented Aug 18, 2021

Adding a Contributing.MD file will make the repo conform to community standards making it better.

  • To make your contributing guidelines visible in the repository's docs directory, type docs/ to create the new directory, then CONTRIBUTING.
  • If a repository contains more than one CONTRIBUTING file, then the file shown in links is chosen from locations in the following order: the .github directory, then the repository's root directory, and finally the docs directory.
    image

For reference: https://github.com/atom/atom/blob/master/CONTRIBUTING.md

@pawlean
Copy link
Contributor

pawlean commented Aug 18, 2021

I totally agree that this would be a great way for our community to contribute with this :) Thanks @Prathamesh-Shanbhag! Will have a look into this.

@Prathamesh-Shanbhag
Copy link
Author

Prathamesh-Shanbhag commented Aug 18, 2021

I actually requested this because I'm trying to solve an issue on the dashboard Component of Gitpod but I'm unable to reproduce the error, so if there were proper steps as to how we can make the contributions that would be great! The issue was #5086

Any help as to how I can go about this will be helpful.

Thanks @pawlean !🙌

@gtsiolis
Copy link
Contributor

Cross-posting from https://github.com/gitpod-io/roadmap/issues/27#issuecomment-947010907:

Making it easier for everyone to contribute is certainly on our radar and we'll do our best to prioritize this given a) the complexity of the project, b) the current limitations of preview environments for forks, and c) our current focus on adding core features as well as making the product reliable. 🗺️

💭 thought: I've tried to outline some distinct next steps we'd like to work on as part of making it easier for everyone to contribute to Gitpod in #6466 and this includes also what we think is a good first MVC (minimum viable change) which is to document how to contribute using minikube, a tool that lets you run Kubernetes locally. ➿

question: @iQQBot having seen the guidelines you added in #6036, I've also noticed you've set up minikube to make it easier to contribute to Gitpod. Would you be up for having a sync chat about the minikube setup? That would be really helpful as we're interested in improving the community contributor experience. @ghuntley could probably join us. 🍵 🍵 🍵

I'll forward a link to this comment to you also via email for visibility but feel free to also reach out in our discord server[1] publicly in #contributing or via DM (Direct Message). 🤖

@ghuntley
Copy link
Contributor

Some additional thoughts:

📝 The destination for a CONTRIBUTING.md should be gitpod-io/.github/CONTRIBUTING.md
📝 CONTRIBUTING.md purpose is to direct people to https://www.gitpod.io/docs/contributing
📝 Content existing at https://www.gitpod.io/docs/contributing enables capture of feedback (via widgets) and that drives continual improvements.

@ghuntley
Copy link
Contributor

ghuntley commented Nov 1, 2021

Have started scaffolding towards above via:

@ghuntley ghuntley closed this as completed Nov 3, 2021
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

4 participants