Skip to content

Commit 32a9dc0

Browse files
committed
Standardise files with files in sous-chefs/repo-management
Signed-off-by: Xorima Bot <[email protected]>
1 parent ed4747e commit 32a9dc0

8 files changed

+174
-58
lines changed

.editorconfig

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#https://EditorConfig.org
2+
# top-most EditorConfig file
3+
root=true
4+
5+
[*]
6+
end_of_line = lf
7+
insert_final_newline = true
8+
indent_style = space
9+
indent_size = 2
10+
charset = utf-8
11+
trim_trailing_whitespace = true

.gitattributes

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* text=auto eol=lf
1+
* text=auto eol=lf

.gitignore

+45-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,48 @@
1-
.kitchen/
2-
.kitchen.local.yml
3-
bin
1+
*.rbc
2+
.config
3+
coverage
4+
InstalledFiles
5+
lib/bundler/man
6+
pkg
7+
rdoc
8+
spec/reports
9+
test/tmp
10+
test/version_tmp
411
tmp
5-
vendor
6-
.bundle
7-
.librarian
8-
.vagrant
12+
_Store
13+
*~
14+
*#
15+
.#*
16+
\#*#
17+
.*.sw[a-z]
18+
*.un~
19+
*.tmp
20+
*.bk
21+
*.bkup
22+
23+
# ruby/bundler files
24+
.ruby-version
25+
.ruby-gemset
26+
.rvmrc
927
Gemfile.lock
28+
.bundle
29+
*.gem
30+
31+
# YARD artifacts
32+
.yardoc
33+
_yardoc
34+
doc/
35+
.idea
36+
37+
# chef stuff
1038
Berksfile.lock
39+
.kitchen
40+
kitchen.local.yml
41+
vendor/
42+
.coverage/
43+
.zero-knife.rb
44+
Policyfile.lock.json
45+
46+
# vagrant stuff
47+
.vagrant/
48+
.vagrant.d/

CODE_OF_CONDUCT.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Community Guidelines
2+
3+
This project follows the Chef Community Guidelines <https://docs.chef.io/community_guidelines.html>

CONTRIBUTING.md

+3-40
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,4 @@
1-
# Contributing to the stunnel Chef cookbook
1+
# Contributing
22

3-
We're excited that you'd like to help us with the stunnel Chef cookbook project!
4-
5-
## Getting in contact with us
6-
7-
In case you get stuck, feel free to open a github issue and we will respond as quickly as we can. For specific issues with ExaBGP, you will want to contact their maintainers for assistance.
8-
9-
## Submitting issues
10-
11-
When submitting an issue, please check the Issues section of this repository on Github to make sure it has not already been reported. If it has been reported, then please contribute to the conversation on the issue and provide any additional information you can. If it has not been reported, please be as detailed as possible.
12-
13-
## Contribution process
14-
15-
1. Fork the repository to your own account if you have not yet done do already.
16-
1. Commit changes to a git branch that is named after the changes you wish to contribute.
17-
1. Create a GitHub Pull Request for your change, following the [Pull Request Requirements](#pull-request-requirements)
18-
1. Perform a [Code Review](#code-review-process) with the cookbook maintainers on the pull request.
19-
20-
### Pull Request Requirements
21-
22-
In order to maintain a high standard of compatibility and consistency for the consumers of our cookbook we like to make sure all pull requests meet the following criteria:
23-
24-
1. **Tests:** To ensure high quality code and protect against regressions in the future we require all changes have ample test coverage. This does not mean 100% coverage or even specific types of coverage. See the TESTING.md file for details on how to run the test suite.
25-
1. **Passing Continuous Integration (CI):** Speaking of tests, the contributed code must pass our full suite of tests on [CircleCI](http://circleci.com) and show a green indicator meaning the latest build passes. If for some reason the build is failing before your pull request please raise the issue in the pull request so we may address it.
26-
27-
### Code Review Process
28-
29-
Code review takes place in GitHub pull requests. See [this article](https://help.github.com/articles/about-pull-requests/) if you're not familiar with GitHub Pull Requests.
30-
31-
Once you open a pull request, cookbook maintainers will review your code using the built-in code review process in Github PRs. The process at this point is as follows:
32-
33-
1. A cookbook maintainer will review your code and merge it if no changes are necessary. Your change will be merged into the cookbooks's `master` branch and will be noted in the cookbook's `CHANGELOG.md` at the time of release.
34-
1. If a maintainer has feedback or questions on your changes they they will set `request changes` in the review and provide an explanation.
35-
36-
## Contribution Guidelines
37-
38-
* **DO** include tests in your pull requests where applicable
39-
* **DONT** modify or change the version number in the metadata.rb as we prefer to control the release cycle ourselves and it makes for code merging headaches that make everyone involved pretty sad
40-
* **DONT** modify the CHANGELOG.md in your pull request as well. The maintainers will auto-generate this before a new release.
41-
* **DO** remember that humans are handling your contributions so please be nice and polite when discussing anything in your pull request.
3+
Please refer to
4+
[https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD)

Dangerfile

+2
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ failure 'Please provide a summary of your Pull Request.' if github.pr_body.lengt
2929

3030
warn 'This is a big Pull Request.' if git.lines_of_code > 400
3131

32+
warn 'This is a Table Flip.' if git.lines_of_code > 2000
33+
3234
# Require a CHANGELOG entry for non-test changes.
3335
if !git.modified_files.include?('CHANGELOG.md') && code_changes?
3436
failure 'Please include a CHANGELOG entry.'

TESTING.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
11
# Testing
22

3-
To run the tests across all platforms, you want to grab the latest [ChefDK][]
4-
install [VirtualBox][], [Vagrant][]
5-
6-
Then run `chef exec rake quick` for unit and style tests.
7-
8-
Use `chef exec rake` for all unit, style, and kitchen tests.
9-
10-
[ChefDK]: https://downloads.chef.io/chef-dk/
11-
[VirtualBox]: https://www.virtualbox.org/wiki/Downloads
12-
[Vagrant]: https://www.vagrantup.com/downloads.html
3+
Please refer to [the community cookbook documentation on testing](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/TESTING.MD).

chefignore

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Put files/directories that should be ignored in this file when uploading
2+
# to a Chef Infra Server or Supermarket.
3+
# Lines that start with '# ' are comments.
4+
5+
# OS generated files #
6+
######################
7+
.DS_Store
8+
ehthumbs.db
9+
Icon?
10+
nohup.out
11+
Thumbs.db
12+
13+
# SASS #
14+
########
15+
.sass-cache
16+
17+
# EDITORS #
18+
###########
19+
.#*
20+
.project
21+
.settings
22+
*_flymake
23+
*_flymake.*
24+
*.bak
25+
*.sw[a-z]
26+
*.tmproj
27+
*~
28+
\#*
29+
mkmf.log
30+
REVISION
31+
TAGS*
32+
tmtags
33+
34+
## COMPILED ##
35+
##############
36+
*.class
37+
*.com
38+
*.dll
39+
*.exe
40+
*.o
41+
*.pyc
42+
*.so
43+
*/rdoc/
44+
a.out
45+
46+
# Testing #
47+
###########
48+
.circleci/*
49+
.codeclimate.yml
50+
.foodcritic
51+
.kitchen*
52+
.rspec
53+
.rubocop.yml
54+
.travis.yml
55+
.watchr
56+
azure-pipelines.yml
57+
examples/*
58+
features/*
59+
Guardfile
60+
kitchen.yml*
61+
Procfile
62+
Rakefile
63+
spec/*
64+
test/*
65+
66+
# SCM #
67+
#######
68+
.git
69+
.gitattributes
70+
.gitconfig
71+
.github/*
72+
.gitignore
73+
.gitmodules
74+
.svn
75+
*/.bzr/*
76+
*/.git
77+
*/.hg/*
78+
*/.svn/*
79+
80+
# Berkshelf #
81+
#############
82+
Berksfile
83+
Berksfile.lock
84+
cookbooks/*
85+
tmp
86+
87+
# Bundler #
88+
###########
89+
vendor/*
90+
Gemfile
91+
Gemfile.lock
92+
93+
# Policyfile #
94+
##############
95+
Policyfile.rb
96+
Policyfile.lock.json
97+
98+
# Cookbooks #
99+
#############
100+
CHANGELOG*
101+
CONTRIBUTING*
102+
TESTING*
103+
CODE_OF_CONDUCT*
104+
105+
# Vagrant #
106+
###########
107+
.vagrant
108+
Vagrantfile

0 commit comments

Comments
 (0)