#28 contributing guide #114
Conversation
williballenthin
added
documentation
|
imho, i recommend that we merge and then any/all make edits for the next week. for example, i'd like to see more details about setting up a development environment and doing an initial checkout. maybe also move text from the installation guide into the contributing guide. |
| All Python code must adhere to the style guide used by capa: | ||
|
|
||
| 1. [PEP8](https://www.python.org/dev/peps/pep-0008/), with clarifications from | ||
| 2. [Willi's style guide](https://docs.google.com/document/d/1iRpeg-w4DtibwytUyC_dDT7IGhNGBP25-nQfuBa-Fyk/edit?usp=sharing), formatted with |
There was a problem hiding this comment.
@williballenthin has an style guide! 😮 Two thoughts:
- Aren't some of those covered by black and isort?
- Maybe it is a good idea to move those to a gist/GitHub repo to link them easily.
There was a problem hiding this comment.
yeah, some of my style guide is covered by isort/black, especially on the formatting end.
other things, like "function should return a single type" don't get enforced (though this one might by via mypy).
There was a problem hiding this comment.
i'm open to moving this style guide into gh. we can copy it into the capa project and call it the "capa style guide" rather than use my name?
|
Really good documentation! 👍 Impressive! 😻
Can we have some more information about this? I have seen @williballenthin using it and I find it a good idea. But I am not sure which component we have and which one I should use if I touch more than one. I think that some more information about this would be helpful. |
|
Do we have documentation about how to link the tests? Otherwise I think it is a good idea to at least link the ci file where the tests are run, so that contributors can easily figure out how to run tests locally. |
|
|
||
| <!-- | ||
|
|
||
| Have you read Capa's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/fireeye/capa/blob/master/CODE_OF_CONDUCT.md |
There was a problem hiding this comment.
I think we should include here also a link to the Suggesting Enhancements secction of the CONTRIBUTING file.
I also think we should mention here (and in the bug report) that issues related to rules should be created in capa-rules.
to be completely honest, i've tried to avoid thinking too hard about this. if you follow a string of my commits, you'll see that i'll using different spelling, names, etc. one after another cause i forget what i've used before. its less about being programmatically accessible and more about:
do you think we should predefine a bunch of components? what kind of further specification would be helpful? |
definitely would like to get more documentation into these files. this PR is just a first pass. please go ahead and add text to address any missing items. imho, i think we should all just commit to master on these docs to get them up to shape, rather than commit-review-merge-repeat. |
I am not sure if we should. If we don't want to enforce it, maybe it is not needed. Maybe adding a few examples is enough. 🤔 |
i derived a lot of the structure and text from https://github.com/atom/atom/blob/master/CONTRIBUTING.md
closes #28