Skip to content

Commit 218723f

Browse files
Update CONTRIBUTING.md
1 parent 26d3bdf commit 218723f

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,37 +18,32 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
1818

1919
1. Fork the repo and create your branch from `master`.
2020
2. If you've added code that should be tested, add tests.
21-
3. If you've changed APIs, update the documentation.
21+
1. This should be done via sanity test section.
22+
2. Attched copy of the passed TF Plan. (Remove sensetive info if necessary)
23+
3. If you've changed variables/functionality, update the documentation.
2224
4. Ensure the test suite passes.
2325
5. Make sure your code lints.
2426
6. Issue that pull request!
2527

2628
## Any contributions you make will be under the MIT Software License
2729
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
2830

29-
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
31+
## Report bugs using Github's [issues](https://github.com/Terraform-VMWare-Modules/terraform-vsphere-vm/issues)
3032
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
3133

3234
## Write bug reports with detail, background, and sample code
33-
[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.
3435

3536
**Great Bug Reports** tend to have:
3637

3738
- A quick summary and/or background
3839
- Steps to reproduce
3940
- Be specific!
40-
- 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
41+
- Give sample code if you can.
4142
- What you expected would happen
4243
- What actually happens
4344
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
4445

4546
People *love* thorough bug reports. I'm not even kidding.
4647

47-
## Use a Consistent Coding Style
48-
I'm again borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
49-
50-
* 2 spaces for indentation rather than tabs
51-
* You can try running `npm run lint` for style unification
52-
5348
## License
5449
By contributing, you agree that your contributions will be licensed under its MIT License.

0 commit comments

Comments
 (0)