Skip to content

Commit 81d9820

Browse files
jerriclynsjohnjerriclynsjohn
committed
Adding wiki, Contributing and slack test
1 parent cf7bff4 commit 81d9820

File tree

3 files changed

+246
-1
lines changed

3 files changed

+246
-1
lines changed

‎CONTRIBUTING.md‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
# Contributing to K-MUG website
2+
3+
Looking to contribute something to K-MUG website? **Here's how you can help.**
4+
5+
Please take a moment to review this document in order to make the contribution
6+
process easy and effective for everyone involved.
7+
8+
Following these guidelines helps to communicate that you respect the time of
9+
the developers managing and developing this open source project. In return,
10+
they should reciprocate that respect in addressing your issue or assessing
11+
patches and features.
12+
13+
14+
## Using the issue tracker
15+
16+
The [issue tracker](https://github.com/k-mug/k-mug.github.io/issues) is
17+
the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
18+
and [submitting pull requests](#pull-requests), but please respect the following
19+
restrictions:
20+
21+
* Please **do not** use the issue tracker for personal support requests. Use K-MUG slack
22+
([`#dev`](https://k-mug.slack.com/messages/dev/) channel)
23+
is a better place to get help.
24+
25+
* Please **do not** derail or troll issues. Keep the discussion on topic and
26+
respect the opinions of others.
27+
28+
* Please **do not** open issues or pull requests which *belongs to* the third party
29+
components. We believe you can approach their respective projects.
30+
31+
32+
## Bug reports
33+
34+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
35+
Good bug reports are extremely helpful, so thanks!
36+
37+
Guidelines for bug reports:
38+
39+
1.**Use the GitHub issue search**— check if the issue has already been
40+
reported.
41+
42+
2.**Check if the issue has been fixed**— try to reproduce it using the
43+
latest `master` or development branch in the repository.
44+
45+
3.**Isolate the problem**— ideally create an
46+
[SSCCE](http://www.sscce.org/) and a live example.
47+
Uploading the project on cloud storage (OneDrive, DropBox, et el.)
48+
or creating a sample GitHub repository is also helpful.
49+
50+
51+
A good bug report shouldn't leave others needing to chase you up for more
52+
information. Please try to be as detailed as possible in your report. What is
53+
your environment? What steps will reproduce the issue? What browser(s) and OS
54+
experience the problem? Do other browsers show the bug differently? What
55+
would you expect to be the outcome? All these details will help people to fix
56+
any potential bugs.
57+
58+
Example:
59+
60+
> Short and descriptive example bug report title
61+
>
62+
> A summary of the issue and browser, OS environments in which it occurs. If suitable, include the steps
63+
> required to reproduce the bug.
64+
>
65+
> 1. This is the first step
66+
> 2. This is the second step
67+
> 3. Further steps, etc.
68+
>
69+
> `<url>` - a link to the project/file uploaded on cloud storage or other publicly accessible medium.
70+
>
71+
> Any other information you want to share that is relevant to the issue being
72+
> reported. This might include the lines of code that you have identified as
73+
> causing the bug, and potential solutions (and your opinions on their
74+
> merits).
75+
76+
77+
## Feature requests
78+
79+
Feature requests are welcome. But take a moment to find out whether your idea
80+
fits with the scope and aims of the project. It's up to *you* to make a strong
81+
case to convince the project's developers of the merits of this feature. Please
82+
provide as much detail and context as possible.
83+
84+
85+
## Pull requests
86+
87+
Good pull requests�patches, improvements, new features�are a fantastic
88+
help. They should remain focused in scope and avoid containing unrelated
89+
commits.
90+
91+
**Please ask first** before embarking on any significant pull request (e.g.
92+
implementing features, refactoring code, porting to a different language),
93+
otherwise you risk spending a lot of time working on something that the
94+
project's developers might not want to merge into the project.
95+
96+
Please adhere to the [coding guidelines](#code-guidelines) used throughout the
97+
project (indentation, accurate comments, etc.) and any other requirements
98+
(such as test coverage).
99+
100+
Adhering to the following process is the best way to get your work
101+
included in the project:
102+
103+
1.[Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
104+
and configure the remotes:
105+
106+
```bash
107+
# Clone your fork of the repo into the current directory
108+
git clone https://github.com/<your-username>/k-mug.github.io.git
109+
# Navigate to the newly cloned directory
110+
cd k-mug.github.io
111+
# Assign the original repo to a remote called "kmug" (or "upstream")
112+
git remote add kmug https://github.com/k-mug/k-mug.github.io.git
113+
```
114+
115+
2. If you cloned a while ago, get the latest changes from upstream:
116+
117+
```bash
118+
git checkout master
119+
git pull kmug master
120+
```
121+
122+
3. Create a new topic branch (off the main project development branch) to
123+
contain your feature, change, or fix:
124+
125+
```bash
126+
git checkout -b <topic-branch-name>
127+
```
128+
129+
4. Commit your changes in logical chunks. Please adhere to these [git commit
130+
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
131+
or your code is unlikely be merged into the main project. Use Git's
132+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
133+
feature to tidy up your commits before making them public. Also, prepend name of the feature
134+
to the commit message. For instance: "SCSS: Fixes compiler results for IFileListener.\nFixes `#123`"
135+
136+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
137+
138+
```bash
139+
git pull [--rebase] kmug master
140+
```
141+
142+
6. Push your topic branch up to your fork:
143+
144+
```bash
145+
git push origin <topic-branch-name>
146+
```
147+
148+
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
149+
with a clear title and description against the `master` branch.
150+
151+
152+
## Code guidelines
153+
154+
- Always use proper indentation.
155+
- <MoretocomeasandwhenIhitonsomehottopic>

‎README.md‎

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,90 @@
1-
K-Mug
1+
[K-MUG](http://k-mug.net) official website source code
2+
=================
3+
4+
<imgsrc="https://k-mug.herokuapp.com/badge.svg">
5+
6+
### About
7+
All the geeks of the community can look into contributing to this repo and make this an epic mess :)
8+
9+
### Quick-start guide
10+
1.[Fork](https://github.com/k-mug/k-mug.github.io/fork) this repo
11+
2. Clone locally
12+
3. Create a new topic branch
13+
4. Commit your changes in logical chunks
14+
5. Locally merge (or rebase) the upstream development branch into your topic branch
15+
6. Push your topic branch up to your fork
16+
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
17+
18+
[Check out the detailed contibution explainer](https://github.com/k-mug/k-mug.github.io/blob/master/CONTRIBUTING.md)
19+
20+
21+
## Local development
22+
23+
Check if you have [all requirements for local environment](http://jekyllrb.com/docs/installation/).
24+
To install all development dependencies install [Bundler](http://bundler.io/).
25+
```bash
26+
gem install bundler
27+
```
28+
and run next command from root folder:
29+
30+
```bash
31+
bundle install
32+
```
33+
34+
To start Jekyll run:
35+
```bash
36+
jekyll serve -w
37+
```
38+
39+
Or try this:
40+
```bash
41+
bundle exec jekyll serve
42+
```
43+
Site will be available at http://127.0.0.1:4000/ or http://localhost:4000/ (on Windows)
44+
45+
**NOTE:** in this mode all changes to html and data files will be automatically regenerated, but after changing ```_config.yml``` you have to restart server.
46+
47+
### Sass(Compass) support
48+
**Note:** You need to install [Node.js](http://nodejs.org/download/)
49+
50+
To watch changes of `.sass` files and compile it to the `.css` on a fly change property `safe: true` to `safe: false` in `_config.yml`.
51+
**Note: It works only on local machine, because GitHub runs Jekyll in `--save`[mode](https://help.github.com/articles/using-jekyll-with-pages/#configuration-overrides)**
52+
53+
Learn more about Sass development from [documentation](https://github.com/k-mug/k-mug.github.io/wiki/Sass-development).
54+
55+
56+
### Resource optimizations (optional)
57+
58+
You can optimize images and minify css and javascript automatically (for now only on Windows).
59+
But for Mac OS users available amazing tool - [imageoptim](https://imageoptim.com/). Thanks [@raphaelsavina](https://github.com/raphaelsavina) for link.
60+
Optimize all images by running this script from `/automation/images/` folder:
61+
```bash
62+
all_image_optimization.bat -d -jtran -pout -pquant -optip -gsicle -svgo
63+
```
64+
65+
To minify CSS and JS run `minify_js.bat` (for Windows) and `minify_js.sh` (for Linux and MacOS) from `/automation/minifying/` folder:
66+
```bash
67+
minify_js.bat
68+
```
69+
70+
Learn more about available optimization options from [documentation](https://github.com/k-mug/k-mug.github.io/wiki/Resources-optimizations).
71+
72+
### Documentation
73+
Quick-start guide is not enough? Checkout [full documentation](https://github.com/k-mug/k-mug.github.io/wiki).
74+
75+
### Used libraries
76+
*[Bootstrap](https://github.com/twbs/bootstrap)
77+
*[Animate.css](https://github.com/daneden/animate.css)
78+
*[Waves](https://github.com/publicis-indonesia/Waves)
79+
*[jquery.appear](https://github.com/bas2k/jquery.appear)
80+
*[jQuery countTo Plugin](https://github.com/mhuggins/jquery-countTo)
81+
*[Typed.js](https://github.com/mattboldt/typed.js)
82+
*[Sticky-kit](https://github.com/leafo/sticky-kit)
83+
84+
85+
See [list of contributors](https://github.com/k-mug/k-mug.github.io/graphs/contributors)
86+
87+
Maintainers: [@jerriclynsjohn](https://github.com/jerriclynsjohn) and [@anuraj](https://github.com/anuraj).
88+
89+
90+

‎_config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ c4sponsorsUrl: "XXXXXXXXXXXXXXXXXXX"
4343
# Navigation
4444
navigationLinks:
4545
- {permalink: "/", text: "Home"}
46+
- {link: "https://k-mug.herokuapp.com/", text: "Slack"}
4647
- {permalink: "/blog/", text: "Blog"}
4748
- {permalink: "/schedule/", text: "Schedule"}
4849
- {permalink: "/speakers/", text: "Speakers"}

0 commit comments

Comments
(0)