Update CONTRIBUTING_GUIDELINES

oam-dev / spec

Open Application Model (OAM).

https://oam.dev

Other

3.06k stars 247 forks source link

Update CONTRIBUTING_GUIDELINES #377

Closed anubhavpulkit closed 4 years ago

anubhavpulkit commented 4 years ago

Description:

Add new points in CONTRIBUTING_GUIDELINES to help beginner developers in Git & GitHub and for bypass common mistakes which are usually done by developers.

fixed #376

Type of Change:

Quality Assurance
Documentation

Checklist:

[x] My PR follows the style guidelines of this project
[x] I have performed a self-review of my own code or materials
[x] I have made corresponding changes to the documentation
[x] Any dependent changes have been merged

Code/Quality Assurance Only

[x] My changes generate no new warnings

ghost commented 4 years ago

All CLA requirements met.

anubhavpulkit commented 4 years ago

Can you merge this PR or you guys need any changes?

hongchaodeng commented 4 years ago

Since it is the weekends, I will leave it for a couple of days in case other owners have any feedback. If no one has objections I will merge then.

wonderflow commented 4 years ago

Idea of this PR is good, but I think OAM spec is different from a normal project that it won't need heavy develop. What's important for OAM spec are use cases and scenarios. So instead of telling how to configure git or develop, I prefer we should tell contributors what's MUST contained in an issue or PR.

anubhavpulkit commented 4 years ago

Idea of this PR is good, but I think OAM spec is different from a normal project that it won't need heavy develop. What's important for OAM spec are use cases and scenarios. So instead of telling how to configure git or develop, I prefer we should tell contributors what's MUST contained in an issue or PR.

for that, we can add issue and PR templates rather than point out in CONTRIBUTING_GUIDELINES.

wonderflow commented 4 years ago

@anubhavsingh16 It's OK.

By the way, we are currently heavily working on https://github.com/crossplane/oam-kubernetes-runtime, that's OAM K8s standard implementation. I think you could help more there. Never mind to pick up any issues you like.

anubhavpulkit commented 4 years ago

@anubhavsingh16 It's OK.

By the way, we are currently heavily working on https://github.com/crossplane/oam-kubernetes-runtime, that's OAM K8s standard implementation. I think you could help more there. Never mind to pick up any issues you like.

ok no worries

anubhavpulkit commented 4 years ago

Thank You :)