Skip to content

Provide a Contributing.md guide for TDC and others #662

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

Closed
DavidBiesack opened this issue Apr 19, 2016 · 3 comments
Closed

Provide a Contributing.md guide for TDC and others #662

DavidBiesack opened this issue Apr 19, 2016 · 3 comments

Comments

@DavidBiesack
Copy link
Contributor

This project would benefit some guidance on how the Technical Development Community can/should contribute. See this comment for example:

Could you rebase your Pull request against current master (or maybe even better, current OpenAPI.next)? There the specs are in the versions folder.

A Contributing.md guide (linked to from the README.md page) would contain information such as (these are suggestions) what branches should be used for pull requests for OAS 3.0 (OpenAPI.next?), what constitutes a good pull request, what tags one should use for issues and what those tags mean (with links to the issues, by tag such as OpenAPI.Next Proposal), what is the workflow/process that the OAI and committers uses for evaluating proposals and pull requests, who the principal committers are and what their roles are, etc. Some of this info (OAI etc.) may be located elsewhere but links to such material would be sufficient.

A central guide such as this on this GitHub project would really help the TDC.

@fehguy
Copy link
Contributor

fehguy commented Apr 19, 2016

Hi @DavidBiesack, I tried to cover that here, on the main README.md:

image

Which brings you to the OpenAPI.next branch. In that README, there's a participation section which says how to contribute.

If you think that could be improved, please let me know how.

@ePaul
Copy link
Contributor

ePaul commented Apr 19, 2016

The good thing about having a CONTRIBUTING.md file is that Github links it from the issue (or pull request) creation form.

@DavidBiesack
Copy link
Contributor Author

Thanks, @fehguy - from that I also found https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/DEVELOPMENT.md which helps.

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

3 participants