]> jfr.im git - irc/freenode/web-7.0.git/blobdiff - README.md
add contributing page
[irc/freenode/web-7.0.git] / README.md
index 9bb3ceeab2cebcb449633445044b016b3928e182..994e53072d24b722b50eaf6babf3742d9f6dc745 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# web-7.0 [![Build Status](https://travis-ci.org/freenode/web-7.0.svg?branch=master)](https://travis-ci.org/freenode/web-7.0) [![irc: #freenode-website](https://img.shields.io/badge/irc-%23freenode--website-brightgreen.svg)](https://webchat.freenode.net/?channels=freenode-website)
+# web-7.0 [![Build Status](https://travis-ci.org/freenode/web-7.0.svg?branch=main)](https://travis-ci.org/freenode/web-7.0) [![irc: #freenode-website](https://img.shields.io/badge/irc-%23freenode--website-brightgreen.svg)](https://webchat.freenode.net/?channels=freenode-website)
 
 A shiny replacement for http://freenode.net.
 
@@ -8,7 +8,7 @@ A shiny replacement for http://freenode.net.
 You'll need our node.js dependencies:
 
 ```console
-$ sudo npm install -g postcss-cli svgo
+$ sudo npm install -g postcss-cli@7.1.2 svgo uglifyjs
 $ npm install
 ```
 
@@ -33,12 +33,14 @@ from any directory, you can also use `cms7 -c /path/to/config.yml`.
 
 - Whenever possible, one commit per feature.
 - If feature/pull-request branches have only one developer, please regularly
-  rebase them onto master until they are merged in.
+  rebase them onto main until they are merged in.
 - Don't merge branches with meaningless commit messages; always squash them
   instead.
 - Wait for discussion of big changes. Your branches will still be here
   tomorrow.
 
+Please comply with the [contribution guidelines](CONTRIBUTING.md)
+
 Helpful tip for those merging PRs: you can browse the tree a merge would
 result in by navigating to
 `https://github.com/freenode/web-7.0/tree/pull/XYZ/merge`, where `XYZ` is the