add contibuting and modify code of conduct. #40
Conversation
There was a problem hiding this comment.
Any chance we can split this into two PRs? Code of Conduct and contributing guides are largely unrelated to each other.
CoC changes look good to me with one minor typo.
I left a handful of comments and minor typo fixes on the contributing doc. I think it's a good doc that covers a lot of information, and it deserves its own PR.
| - `podcast` | ||
|
|
||
| 3. Specify that you will work on this issue. This lets others know that someone is actively working on the project. | ||
| 4. Fork the repository on your profile and make changes locally. |
There was a problem hiding this comment.
This section feels a bit incomplete. I like the section as a whole, but forking the repository is closer to the beginning of getting a change through than it is to the end.
There was a problem hiding this comment.
It is, sadly I'm wasn't sure what the steps would be after that. With a little more clarity I hope to add some of the steps as good first issues for others as we begin to better define them.
|
|
||
| We use [`httpx`](https://www.python-httpx.org) to make REST API calls to our third-party platforms and `pytest-httpx`(https://pypi.org/project/pytest-httpx/) to mock those API calls in testing. | ||
|
|
||
| We are not taking requests to change any of the services. Solicitation of services is not allowed and will be seen as Harassment and Handled according to our [CODE of CONDUCT](CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
I agree with "no solicitation" in general, but this feels like either
- a bit of a preemptive hard line to take or
- something that should be spelled out explicitly in the code of conduct rather than in a document containing contributing instructions
There was a problem hiding this comment.
I put this here because if someone has a service or they are willing to sponsor us to use that service and it's sincerely better than what we're doing, I won't complain. That said I feel like sending a PR that ultimately is "CHANGED from SERVICE X to Y" code contributions is a waste of that persons time and something I want to gaurd against.
I feel like that's something that does happen a lot during OSS contribution pushes (#HacktoberFest)
I'm okay with removing the text and creating a discussion point around it.
|
|
||
| If the content has been released already, submit a PR to the corresponding file in `/site/content/YYYY-MM-DD.md`. Once the show and newsletter have been released, we can manually change the information in the archive but it is unlikely that people will get the change before it has been sent to them. | ||
|
|
||
| We store the output of Render Engine in the `web` repository. This helps to eliminate confusion as to where content needs to be updated. The website is rebuilt with every pull request. |
There was a problem hiding this comment.
| We store the output of Render Engine in the `web` repository. This helps to eliminate confusion as to where content needs to be updated. The website is rebuilt with every pull request. | |
| We store the output of Render Engine in the `web` branch. This helps to eliminate confusion as to where content needs to be updated. The website is rebuilt with every pull request. |
Co-authored-by: Jon Banafato <[email protected]>
Co-authored-by: Jon Banafato <[email protected]>
Co-authored-by: Jon Banafato <[email protected]>
|
|
||
| We'll also use GitHub Actions to interact with issues as they relate to the associated [Project](https://github.com/users/kjaymiller/projects/4) boards. | ||
|
|
||
| Just adding a missing period here. |
There was a problem hiding this comment.
| Just adding a missing period here. |
Sorry, that was meant to be a comment and not part of the suggestion. I must have accidentally put it inside of the suggestion block instead of after.
|
I went ahead and merged the changes to Code of Conduct and will figure out how to make a new PR for the contributing doc with all the suggestions added here. |
Adds a Contributing document per #39 and updates the code of conduct to be more specific to our project