info/php-the-right-way
1
0
Fork 0
mirror of https://github.com/codeguy/php-the-right-way.git synced 2025-08-29 16:19:55 +02:00
Code Issues Projects Releases Wiki Activity

Improve jekyll server execution instructions

Browse Source
This commit is contained in:
Phil Sturgeon
2016-02-15 21:50:06 -05:00
parent dc7ab1b3bc
commit 0e875747a0
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@@ -1,6 +1,6 @@
# Contributing to PHP The Right Way # Contributing to PHP The Right Way
Enjoy [PHP The Right Way](http://phptherightway.com) and want to get Enjoy [PHP The Right Way](http://phptherightway.com) and want to get
involved? Great! There are plenty of ways you can help out. involved? Great! There are plenty of ways you can help out.
Please take a moment to review this document in order to make the contribution Please take a moment to review this document in order to make the contribution
@@ -15,8 +15,8 @@ patches and features.
## Using the issue tracker ## Using the issue tracker
The [issue tracker](https://github.com/codeguy/php-the-right-way/issues) is The [issue tracker](https://github.com/codeguy/php-the-right-way/issues) is
the preferred channel for changes: spelling mistakes, wording changes, new the preferred channel for changes: spelling mistakes, wording changes, new
content and generally [submitting pull requests](#pull-requests), but please content and generally [submitting pull requests](#pull-requests), but please
respect the following restrictions: respect the following restrictions:
* Please **do not** use the issue tracker for personal support requests (use * Please **do not** use the issue tracker for personal support requests (use
@@ -29,8 +29,8 @@ respect the following restrictions:
<a name="pull-requests"></a> <a name="pull-requests"></a>
## Pull Requests ## Pull Requests
Pull requests are a great way to add new content to PHP The Right Way, as well Pull requests are a great way to add new content to PHP The Right Way, as well
as updating any browser issues or other style changes. Pretty much any sort of as updating any browser issues or other style changes. Pretty much any sort of
change is accepted if seen as constructive. change is accepted if seen as constructive.
Adhering to the following this process is the best way to get your work Adhering to the following this process is the best way to get your work
@@ -67,10 +67,8 @@ included in the project:
```bash ```bash
# Install the needed gems through Bundler # Install the needed gems through Bundler
bundle install bundle install
# Build and open _site/index.html in your browser... # Run the local server
jekyll build [--watch] bundle execute jekyll s
# ...or run a local server to easily develop:
jekyll serve
``` ```
5. Commit your changes in logical chunks. Please adhere to these [git commit 5. Commit your changes in logical chunks. Please adhere to these [git commit
@@ -97,7 +95,7 @@ included in the project:
## Contribution Agreement and Usage ## Contribution Agreement and Usage
By submitting a pull request to this repository, you agree to allow the project By submitting a pull request to this repository, you agree to allow the project
owners to license your work under the the terms of the [Creative Commons Attribution-NonCommercial-ShareAlike owners to license your work under the the terms of the [Creative Commons Attribution-NonCommercial-ShareAlike
3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/). 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/).
@@ -118,4 +116,4 @@ All content is completely free now, and always will be.
3. Wrap all text to 120 characters 3. Wrap all text to 120 characters
4. Code samples should adhere to PSR-1 or higher 4. Code samples should adhere to PSR-1 or higher
5. Use [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/) for all content 5. Use [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/) for all content
6. Use language agnostic urls when refering to external websites such as the [php.net](http://php.net/urlhowto.php) manual 6. Use language agnostic urls when referring to external websites such as the [php.net](http://php.net/urlhowto.php) manual