https://github.com/iver-wharf/rfcs
Wharf approved and pending design decisions using request for comment (RFC) process
https://github.com/iver-wharf/rfcs
rfc rfc-process rfcs wharf
Last synced: 2 months ago
JSON representation
Wharf approved and pending design decisions using request for comment (RFC) process
- Host: GitHub
- URL: https://github.com/iver-wharf/rfcs
- Owner: iver-wharf
- License: mit
- Created: 2021-04-19T06:50:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T03:54:02.000Z (over 3 years ago)
- Last Synced: 2025-03-06T00:29:34.797Z (about 1 year ago)
- Topics: rfc, rfc-process, rfcs, wharf
- Language: SCSS
- Homepage: https://wharf.iver.com/rfcs
- Size: 580 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wharf RFCs (Request For Comments)
[](https://www.codacy.com/gh/iver-wharf/rfcs/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=iver-wharf/rfcs\&utm_campaign=Badge_Grade)
For any substantial change that needs to be thought through in Wharf, we try to
use RFCs for them instead of internally trying to talk it out in meetings.
Not every decision needs an RFC, nor is any RFC excessive. This is the
start of our journey with RFCs, so we're trying to limit them to changes with
major impact.
Read more about the Wharf RFC process over at the GitHub pages:
## Disclaimer
The documents and markdown files in this repository are documentation of our
decision making. Only to have a place to look back at, similar to meeting
notes or recordings, so we can see our previous decisions.
**It is not** documentation of how things are meant to be implemented. Do not
take this repository as the source of truth of how Wharf works. Please check
out our [Wharf documentation](https://wharf.iver.com/) or the
[source code](https://github.com/iver-wharf/) itself to gain the actual source
of truth.
## Running locally
This repository is hosted using GitHub Pages, but you can also host it locally
if you want.
1. Install Jekyll requirements, such as Ruby v2.4.0 (or higher), GCC, and Make
Jekyll's installation guide:
2. Install `bundler` Ruby gem.
You will need administrator access, so make sure to add `sudo` or run the
terminal as administrator to be able to install these gems.
```sh
# Linux/Mac
$ sudo gem install bundler
```
```pwsh
# Windows (PowerShell), make sure to start the terminal as administrator
PS> gem install bundler
```
3. Install dependencies (Jekyll, Just-The-Docs theme, etc)
```sh
bundle install
# Optionally, if you have GNU make
make deps
```
4. Start the site. This does not need administrator access.
```sh
bundle exec jekyll serve
# Optionally add the --livereload flag for automatic refresh
bundle exec jekyll serve --livereload
# Optionally, if you have GNU make
make serve
```
5. Visit the locally hosted page over at:
## Linting markdown
```sh
make deps # download linting dependencies
make lint
make lint-md # only lint Markdown files
```
Some errors can be fixed automatically. Keep in mind that this updates the
files in place.
```sh
make lint-fix
make lint-fix-md # only lint and fix Markdown files
```
---
Maintained by [Iver](https://www.iver.com/en).
Licensed under the [MIT license](./LICENSE).