Skip to content

Commit 46b41b0

Browse files
committed
Merge pull request hoodiehq#161 from zoepage/gh-pages
added information for new contributors
2 parents 246774c + 1f2fc51 commit 46b41b0

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,25 @@ The color-scheme mixin builds all relevant color stylings you need to create a f
8484

8585
For example take a look at the calendar icon on the index page.
8686

87+
## Contributing
88+
We are very happy about you contributing to the Hoodie website! We have defined a process that makes it easy for you to contribute and helps us maintain the website.
89+
90+
Please fork the website and send a Pull Request for your contribution. Here is <a href="http://hood.ie/blog/contributing-to-hoodie.html" target="_blank">an amazing article</a>, that explains how you can fork and edit files, also how to send a Pull Request. It's especially great for new contributors! Please do not forget to add comments on what you did and why, especially if your changes are bit more complex.
91+
92+
We will review the Pull Request (PR) and merge or comment it.
93+
94+
**Content changes and typos**
95+
Simple typo fixes can be merged right away, if you have the permission to do so. We trust you with that!
96+
97+
In addition, if you want to merge a PR that includes structural changes, make sure to test the whole site on your computer to make sure nothing breaks. We want to avoid having a broken site online. Once a PR is merged (into the gh-pages branch), the changes will be on the live site a few seconds later.
98+
99+
**Layout changes and additions**
100+
We wrote a small css-framework for our websites (hood.ie, docs, blog, faq), so the CI remains the same everywhere and we can make changes at the design pretty quick, also we are able to build new sites pretty quick and without a haze!
101+
102+
If you`d love to change something within the layout or add something specific to the website, please read the <a href="https://github.com/hoodiehq/hoodie-css#how-to-use" target="_blank">"How to use the hoodie-css framework"-guide</a> first!
103+
104+
Then fork, commit and PR! <3
105+
87106
## Deployments
88107

89108
The new hood.ie Website doesn't need to be deployed after making changes. (Only thing you might need to know: when making changes locally on files like `_config.yml` or on blog post drafts (`_drafts`), you may need to restart your local Jekyll so you can also see them locally immediately (abort on Mac with `cmd+c`, restart with `jekyll serve --watch --drafts`(which then also gives you blog drafts).)

0 commit comments

Comments
 (0)