Skip to content

Commit 2fd7dab

Browse files
committed
Add contributors bot and docs.
1 parent 0186c9d commit 2fd7dab

File tree

3 files changed

+19
-29
lines changed

3 files changed

+19
-29
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
version: 2.1
33
orbs:
4-
kitchen: sous-chefs/kitchen@1.0.1
4+
kitchen: sous-chefs/kitchen@2.0.2
55

66
workflows:
77
kitchen:

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@
33
We are glad you want to contribute to the sysctl cookbook! The first
44
step is the desire to improve the project.
55

6+
## Recognizing All Contributors
7+
This project follows the [All Contributors](https://allcontributors.org/docs/en/overview) specification for recognizing contributors to an open source project in a way that recognizes different types of contributions, not just code.
8+
9+
### Adding a contributor
10+
Contributors are encouraged to add themselves to the list using the [All Contributors (Git Hub) bot](https://allcontributors.org/docs/en/bot/overview).
11+
See the bot [usage instructions](https://allcontributors.org/docs/en/bot/usage)).
12+
613
## Quick-contribute
714

8-
* Create an issue on the github [issue tracker](https://github.com/sous-chefs/sysctl/issues)
15+
* Create an issue on the github [issue tracker](https://github.com/jlenv/jlenv/issues)
916
* Link to your patch as a rebased git branch or pull request from the ticket
1017

1118
We regularly review contributions and will get back to you if we have

README.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
[![Cookbook Version](https://img.shields.io/cookbook/v/jlenv-cookbook.svg)](https://supermarket.chef.io/cookbooks/jlenv-cookbook)
44
[![Build Status](https://img.shields.io/circleci/project/github/jlenv/jlenv-cookbook/master.svg)](https://circleci.com/gh/jlenv/jlenv-cookbook)
55
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
6+
[![CircleCI](https://circleci.com/gh/taqtiqa-mark/jlenv-cookbook.svg?style=svg)](https://circleci.com/gh/taqtiqa-mark/jlenv-cookbook)
67

78
## Description
89

9-
Manages [jlenv][https://github.com/jlenv] and its installed Julias.
10+
Manages [jlenv][https://github.com/jlenv/jlenv] installed Julias.
1011

1112
## Maintainers
1213

@@ -25,16 +26,20 @@ This cookbook requires Chef 13.0+.
2526
- macOS (not currently tested)
2627
- RHEL derivatives (RHEL, CentOS, Amazon Linux, Oracle, Scientific Linux)
2728
- openSUSE and openSUSE leap
29+
- Windows (not supported)
2830

2931
# Usage
3032

3133
**Please read**
3234

3335
Example installations are provided in `test/fixtures/cookbooks/test/recipes/`.
3436

35-
A `jlenv_system_install` or `jlenv_user_install` is required to be set so that jlenv knows which version you want to use, and is installed on the system.
37+
A `jlenv_user_install` is required to be set so that jlenv knows which version you want to use, and is installed on the system.
3638

37-
System wide installations of jlenv are supported by this cookbook, but discouraged by the jlenv maintainer, see [these][https://github.com/rbenv/rbenv/issues/38] [two][https://github.com/rbenv/rbenv/issues/306] issues in the rbenv repository.
39+
#### NOTE:
40+
> System wide installations of jlenv are discouraged by the jlenv maintainer.
41+
42+
However they are supported by this cookbook, see [these][https://github.com/rbenv/rbenv/issues/38] [two][https://github.com/rbenv/rbenv/issues/306] issues in the rbenv repository for the reasons why.
3843

3944
## Pkg
4045

@@ -54,7 +59,7 @@ end
5459

5560
## Global
5661

57-
Sets the global julia version. The name of the resource is the version to set.
62+
Sets the global Julia version. The name of the resource is the version to set.
5863

5964
```julia
6065
jlenv_global '1.1.0' do
@@ -163,31 +168,9 @@ This cookbook takes advantage of managing profile fragments in an `/etc/profile.
163168
Pull requests are very welcome! Make sure your patches are well tested.
164169

165170
## Contributors
166-
167171
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
168172
<!-- prettier-ignore -->
169173
<table><tr><td align="center"><a href="http://blog.taqtiqa.com"><img src="https://avatars1.githubusercontent.com/u/1468258?v=4" width="100px;" alt="Mark Van de Vyver"/><br /><sub><b>Mark Van de Vyver</b></sub></a><br /><a href="#infra-taqtiqa-mark" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/taqtiqa-mark/jlenv-cookbook/commits?author=taqtiqa-mark" title="Tests">⚠️</a> <a href="https://github.com/taqtiqa-mark/jlenv-cookbook/commits?author=taqtiqa-mark" title="Code">💻</a></td></tr></table>
170174

171175
<!-- ALL-CONTRIBUTORS-LIST:END -->
172-
This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
173-
174-
### Backers
175-
176-
Thank you to all our backers!
177-
178-
![https://opencollective.com/sous-chefs#backers](https://opencollective.com/sous-chefs/backers.svg?width=600&avatarHeight=40)
179-
180-
### Sponsors
181-
182-
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
183-
184-
![https://opencollective.com/sous-chefs/sponsor/0/website](https://opencollective.com/sous-chefs/sponsor/0/avatar.svg?avatarHeight=100)
185-
![https://opencollective.com/sous-chefs/sponsor/1/website](https://opencollective.com/sous-chefs/sponsor/1/avatar.svg?avatarHeight=100)
186-
![https://opencollective.com/sous-chefs/sponsor/2/website](https://opencollective.com/sous-chefs/sponsor/2/avatar.svg?avatarHeight=100)
187-
![https://opencollective.com/sous-chefs/sponsor/3/website](https://opencollective.com/sous-chefs/sponsor/3/avatar.svg?avatarHeight=100)
188-
![https://opencollective.com/sous-chefs/sponsor/4/website](https://opencollective.com/sous-chefs/sponsor/4/avatar.svg?avatarHeight=100)
189-
![https://opencollective.com/sous-chefs/sponsor/5/website](https://opencollective.com/sous-chefs/sponsor/5/avatar.svg?avatarHeight=100)
190-
![https://opencollective.com/sous-chefs/sponsor/6/website](https://opencollective.com/sous-chefs/sponsor/6/avatar.svg?avatarHeight=100)
191-
![https://opencollective.com/sous-chefs/sponsor/7/website](https://opencollective.com/sous-chefs/sponsor/7/avatar.svg?avatarHeight=100)
192-
![https://opencollective.com/sous-chefs/sponsor/8/website](https://opencollective.com/sous-chefs/sponsor/8/avatar.svg?avatarHeight=100)
193-
![https://opencollective.com/sous-chefs/sponsor/9/website](https://opencollective.com/sous-chefs/sponsor/9/avatar.svg?avatarHeight=100)
176+
This project exists thanks to all the people who contribute.

0 commit comments

Comments
 (0)