add contributing helper doc #86
Conversation
|
@xiangchenjhu This looks great! Would you mind adding this to https://github.com/ssec-jhu/base-template when you have some spare time, please, cheers! BTW I opened ssec-jhu/base-template#151 for this. |
xiangchenjhu
requested review from
amitschang
and removed request for
amitschang
|
oh sorry, I missed that this is draft! |
It's should have been turned to formal PR. Thanks for reminding |
I added the link for CONTRIBUTING in README. I didn't find the comment inline you mentioned (because that's the draft PR?) Could you add it again, Thanks! |
CONTRIBUTING.md
Outdated
|
|
||
| ## Making Changes | ||
|
|
||
| - **Coding Standards**: Follow PEP 8 for Python code. Use `ruff format` or `tox -e format` to ensure code formatting aligns with the repository’s requirements. |
There was a problem hiding this comment.
Here I think it would be better to just use the tox command. Fewer options is better and tox codifies more than just the formatting - we can change in it's code without changing advice here.
There was a problem hiding this comment.
That makes sense. Using tox -e format as the single command has clear advantages. I initially used ruff format . because it was mentioned in the CI error, but after running tox -e format, it made additional adjustments on 9 more files :).
|
Thanks for the advice |
No description provided.