Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yousinix committed Jun 30, 2019
1 parent dbb8b60 commit fd44bba
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contribute to portfolYOU

1. [Fork][fork] and clone the repository.
1. Create a new branch based on `master`: `git checkout -b <my-branch-name>`
1. Make your changes, and make sure the site still builds.
1. Push to your fork and [submit a pull request][compare] from your branch to `master`
1. Pat yourself on the back and wait for your pull request to be reviewed.
1. *Here are a few things you have to do:*
- Write a good commit message.
- Follow the style guide where possible.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.

[fork]: https://github.com/YoussefRaafatNasry/portfolYOU/fork
[compare]: https://github.com/YoussefRaafatNasry/portfolYOU/compare
2 changes: 1 addition & 1 deletion docs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ portfolYOU is a free modern open-source Jekyll portfolio and blogging theme that
#### As a GitHub Pages remote theme

1. [Download][download] portfolYOU as .zip from official [repo][repo] then extract the files.
1. Delete unnecessary files and folders: `README.md`, `LICENSE`, `docs/`
1. Delete unnecessary files and folders: `README.md`, `CONTRIBUTING.md`, `LICENSE`, `docs/`
1. Delete theme directories, _as they will be included remotely_ : `_includes/`, `_layouts/`, `_sass/`, `assets/`
1. Delete `Gemfile` and `.gitignore` if you aren't going to set up the theme [locally].
1. Your directory structure should be looking something like this:
Expand Down

0 comments on commit fd44bba

Please sign in to comment.