Add CONTRIBUTING.md #533
Add CONTRIBUTING.md #533
Conversation
d37739e to
28b1b5a
Compare
28b1b5a to
4f94310
Compare
|
@mariocj89 MInd doing a quick review here? |
|
|
||
| 3. A description of the problem - what *is* happening and what *should* happen. | ||
|
|
||
| While pull requests fixing bugs are accepted, they are *not* required - the bug report in itself is a great contribution. |
There was a problem hiding this comment.
Do you accept xfailing test cases as bug reports?
There was a problem hiding this comment.
I haven't been a huge fan of that in the past, but it's a good point. I think it should be added when #519 is fixed.
CONTRIBUTING.md
Outdated
|
|
||
| ### Feature requests | ||
|
|
||
| If you would like to see a new feature in `dateutil`, it is probably best to start an issue for discussion. You are welcome to prepare a pull request to start, but if it's going to be a lot of work, it's probably best to start by opening an issue so that you can know. |
There was a problem hiding this comment.
I'd refrase that. I can see the meaning but "reads weird" for me
CONTRIBUTING.md
Outdated
|
|
||
| ### Pull requests | ||
|
|
||
| If you would like to fix something in `dateutil` - improvements to documentation, bug fixes, feature implementations, fixes to the build system, etc - pull requests are welcome! Try to keep your coding to [PEP 8 style](https://www.python.org/dev/peps/pep-0008/), with the minor modification that the existing `dateutil` class naming style does not use the CapWords convention. |
There was a problem hiding this comment.
In the tests there are many non pep8 violations, like method names being camelcase.
Should the contributor just "adhere" to the existing style or follow PEP8?
|
just FYI in case it is of your interest there is a support for issues/pr templates by using .github. Example: https://github.com/python/cpython/tree/master/.github |
|
I think I skipped on the templates because as a bug reporter / PR submitter, I've often find they just get in the way. That said, the median contributor would probably benefit from them. |
|
@mariocj89 Updated. |
This is an initial version of
CONTRIBUTING.md. It adds the stipulation that all new contributions will be dual-licensed under Apache 2.0 and BSD 3-clause license so it's more explicit what the licenses are.