Benjamin_Loison/waybackpy
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Akash
2020-07-18 00:56:05 +05:30
committed by GitHub
parent 995946b349
commit 54453a1e80
1 changed files with 2 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -27,25 +27,21 @@ In short, when you submit code changes, your submissions are understood to be un
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
## Write bug reports with detail, background, and sample code ## Write bug reports with detail, background, and sample code
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
**Great Bug Reports** tend to have: **Great Bug Reports** tend to have:
- A quick summary and/or background - A quick summary and/or background
- Steps to reproduce - Steps to reproduce
- Be specific! - Be specific!
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing - Give sample code if you can. Include sample code so that *anyone* with a base R setup can run to reproduce what I was seeing
- What you expected would happen - What you expected would happen
- What actually happens - What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People *love* thorough bug reports. I'm not even kidding. People *love* thorough bug reports. I'm not even kidding.
## Use a Consistent Coding Style
I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
* 2 spaces for indentation rather than tabs
* You can try running `npm run lint` for style unification
## License ## License
By contributing, you agree that your contributions will be licensed under its MIT License. By contributing, you agree that your contributions will be licensed under its MIT License.