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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for open source contributors #1990

Closed
terrelln opened this issue Feb 5, 2020 · 5 comments
Closed

Improve documentation for open source contributors #1990

terrelln opened this issue Feb 5, 2020 · 5 comments
Assignees
@Cyan4973
Labels
documentation release-blocking Must be done by the release

Comments

@terrelln
Copy link
Contributor

terrelln commented Feb 5, 2020

Our documentation for how to develop and test a PR for open source contributors is lacking.

  • Workflow for submitting a PR.
  • Style guide / how big should your PR be / what should the summary be / what should you benchmark.
  • How to run local tests and fuzzers. What does the continuous integration do?
  • How to set up continuous integration in your repository.
@bimbashrestha bimbashrestha self-assigned this Feb 5, 2020
This was referenced Feb 18, 2020
Merged
Closed
@bimbashrestha bimbashrestha reopened this Feb 20, 2020
@bimbashrestha
Copy link
Contributor

We still need some documentation on benchmarking and style

@terrelln
Copy link
Contributor Author

terrelln commented May 1, 2020

Related to #2102

@bimbashrestha
Copy link
Contributor

bimbashrestha commented May 5, 2020 •
edited
Loading

Moving related issue tasks to this one and closing that one:

TODO:

  • How to measure optimizations
  • Static analysis
  • Style

@bimbashrestha bimbashrestha added the release-blocking Must be done by the release label May 5, 2020
This was referenced May 5, 2020
Closed
Merged
Merged
@bimbashrestha
Copy link
Contributor

I think the only thing remaining on this issue is the style documentation. And I recall we decided @Cyan4973 should be the one to do that. So I'm reassigning it.

@Cyan4973
Copy link
Contributor

Cyan4973 commented May 7, 2021

Coding style paragraph (finally) added

@Cyan4973 Cyan4973 closed this as completed May 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Cyan4973 Cyan4973

Labels
documentation release-blocking Must be done by the release
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Cyan4973 @terrelln @bimbashrestha