Add code of conduct and pull requests guide#70
Conversation
| matrix: | ||
| os: [ubuntu-latest, macos-latest] | ||
| python-version: ['3.9', '3.10', '3.11'] | ||
| python-version: ['3.10', '3.11'] |
There was a problem hiding this comment.
Great catch! Thanks for updating this
|
Add your files to the index.rst file so that they show up in read the docs: You can preview of how your files look in read the docs by clicking on docs under the checks done by the PR |
|
These are great additions to the dev guide, thanks for working on this! |
|
@vmartinez-cu great catch with the index - I made those changes |
| lasp_github_org.md | ||
| lasp_github_org.md |
There was a problem hiding this comment.
There's a duplicate here so it's showing up twice in the docs: https://lasp-developer-guide--70.org.readthedocs.build/en/70/workflows/open_source/index.html
| 1. If you have a lot of commits, clean up the commits by running a [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) and combining commits. | ||
|
|
There was a problem hiding this comment.
Adding a link to some info on git rebase -i could be helpful to include too for combining/modifying commits (i.e. https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
| 1. If you would like to request a specific review from someone, make sure they are marked as a reviewer or called out in a comment on the review (by typing `@<username>`) | ||
| 1. Please respond to PR comments in a timely manner and according to the LASP Code of Conduct |
There was a problem hiding this comment.
suggestion - consider adding a brief bullet on writing a clear PR summary that explains the what/why/how. That could go here or in the section before.
Related to this, you could also mention that a project can set up a template to help a team provide key info in the summary and link to the github page on how to set this up (https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/managing-and-standardizing-pull-requests)
vmartinez-cu
left a comment
There was a problem hiding this comment.
Looks great! I just have one change request to make some urls clickable and a couple suggestions that aren't required
I wanted to link to a shared code of conduct and pull requests guide in Curryer. The code of conduct is pulled from the LASP organization, and the pull requests guide is a union between the IMAP pull request guide and the Libera pull request guide. Hopefully it's generic enough to be useful.
I also had some issues with pre-commit so I added that to the poetry file and dropped support for Python 3.9 because it is past end of life.