Skip to content

Commit c7af9ca

Browse files
committed
Add CONTRIBUTING.md
1 parent ade11e3 commit c7af9ca

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to Reqnroll WebSite
2+
3+
## Building the site locally
4+
5+
Prerequisites:
6+
7+
* Ruby v3.3 or later
8+
9+
Install dependencies
10+
11+
* Invoke `bundle install`
12+
13+
In order to test your changes, there are multiple options:
14+
15+
* Build the site and host it locally with live reload (recommended)
16+
* Invoke `bundle exec jekyll serve --livereload`
17+
* This will host the site at http://127.0.0.1:4000/
18+
* Build the site once and host it locally
19+
* Invoke `bundle exec jekyll serve`
20+
* This will host the site at http://127.0.0.1:4000/
21+
* Build the site once
22+
* Invoke `bundle exec jekyll build`
23+
* The generated site is in the `_site` folder

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,5 @@ sass:
114114

115115
exclude:
116116
- README.md
117+
- CONTRIBUTING.md
117118
- LICENSE

0 commit comments

Comments
 (0)