Skip to content
This repository has been archived by the owner on Mar 15, 2020. It is now read-only.

Commit

Permalink
Release version 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
maxmert committed May 7, 2014
2 parents becce7e + 3ef35f9 commit 8687b46
Show file tree
Hide file tree
Showing 833 changed files with 197,894 additions and 881 deletions.
2 changes: 1 addition & 1 deletion .bowerrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"directory": "docs/js/bower"
"directory": "js/bower"
}
8 changes: 6 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.sass-cache
.sublime-workspace
__

.DS_Store
**/.DS_Store
nbproject
manifest.mf
Expand All @@ -18,4 +18,8 @@ npm-debug.log


# Bower stuff.
docs/js/bower/
bower
docs/js/bower

# Maxmertkit stuff
mkit.json
192 changes: 192 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
# Contributing to Maxmertkit

Looking to contribute something to Maxmertkit? **Here's how you can help.**

Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue or assessing
patches and features.


## Using the issue tracker

The [issue tracker](https://github.com/maxmert/maxmertkit/issues) is
the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
and [submitting pull requests](#pull-requests), but please respect the following
restrictions:

* Please **do not** use the issue tracker for personal support requests. Stack
Overflow ([`twitter-maxmertkit-3`](http://stackoverflow.com/questions/tagged/maxmertkit-1) tag) or [IRC](https://github.com/maxmert/maxmertkit/blob/master/README.md#community) are better places to get help.

* Please **do not** derail or troll issues. Keep the discussion on topic and
respect the opinions of others.

* Please **do not** open issues or pull requests regarding the code in
[`Normalize`](https://github.com/necolas/normalize.css) (open them in
their respective repositories).


## Bug reports

A bug is a _demonstrable problem_ that is caused by the code in the repository.
Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

1. **Use the GitHub issue search** — check if the issue has already been
reported.

2. **Check if the issue has been fixed** — try to reproduce it using the
latest `master` or development branch in the repository.

3. **Isolate the problem** — ideally create a [reduced test
case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
[This JS Bin](http://jsbin.com/EBAwOkOK/1) is a helpful template.


A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is
your environment? What steps will reproduce the issue? What browser(s) and OS
experience the problem? Do other browsers show the bug differently? What
would you expect to be the outcome? All these details will help people to fix
any potential bugs.

Example:

> Short and descriptive example bug report title
>
> A summary of the issue and the browser/OS environment in which it occurs. If
> suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
>
> `<url>` - a link to the reduced test case
>
> Any other information you want to share that is relevant to the issue being
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).

## Feature requests

Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.


## Pull requests

Good pull requests—patches, text fixes, improvements, new features &mdash; are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.

**Do without asking** pull requests with fixes of documentation texts.

**Please ask first** before embarking on any significant pull request (e.g.
implementing features, refactoring code, porting to a different language),
otherwise you risk spending a lot of time working on something that the
project's developers might not want to merge into the project.

Please adhere to the [coding guidelines](#code-guidelines) used throughout the
project (indentation, accurate comments, etc.) and any other requirements
(such as test coverage).

Adhering to the following process is the best way to get your work
included in the project:

1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
and configure the remotes:

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/maxmertkit.git
# Navigate to the newly cloned directory
cd maxmertkit
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/maxmert/maxmertkit.git
```

2. If you cloned a while ago, get the latest changes from upstream:

```bash
git checkout master
git pull upstream master
```

3. Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix:

```bash
git checkout -b <topic-branch-name>
```

4. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
or your code is unlikely be merged into the main project. Use Git's
[interactive rebase](https://help.github.com/articles/interactive-rebase)
feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:

```bash
git pull [--rebase] upstream master
```

6. Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
```

7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description against the `master` branch.

**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
license your work under the terms of the [MIT License](LICENSE.md).


## Code guidelines

### HTML

- Tabs for indentation, never spaces.
- Double quotes prefered.
- Always use proper indentation.
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
- Use CDNs and HTTPS for third-party JS when possible. We don't use protocol-relative URLs in this case because they break when viewing the page locally via `file://`.
- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility.

### CSS

- CSS changes must be done in `.sass` files first, never just in the compiled `.css` files.
- Adhere to the [CSS property order](http://markdotto.com/2011/11/29/css-property-order/).
- Multiple-line approach (one property and value per line).
- Always a space after a property's colon (e.g., `display: block` and not `display:block`).
- Don't add vendor prefixed properties to their unprefixed counterparts (e.g., only `box-sizing` and not also include `-webkit-box-sizing`), as this is done automagically at build time.
- Attribute selectors, like `input[type="text"]` should always wrap the attribute's value in double quotes, for consistency and safety (see this [blog post on unquoted attribute values](http://mathiasbynens.be/notes/unquoted-attribute-values) that can lead to XSS attacks).
- Attribute selectors should only be used where absolutely necessary (e.g., form controls) and should be avoided on custom components for performance and explicitness.
- Except in rare cases, don't remove default `:focus` styles (via e.g. `outline: none;`) without providing alternative styles. See [this A11Y Project post](http://a11yproject.com/posts/never-remove-css-outlines/) for more details.

### Coffeescript

- tabs (no spaces)
- strict mode
- "Attractive"


### Tests and checking coding style

I really need your help in writing tests for js.
You can run `gulp test` before committing to ensure your changes follow our coding standards.


## License

By contributing your code, you agree to license your contribution under the [MIT license](https://github.com/maxmert/maxmertkit/blob/master/LICENSE).
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2012-2014 Maxmert

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
141 changes: 141 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
# [Maxmertkit](http://maxmertkit.com)

Maxmertkit, powerful, most customizable and easiest for usage mobile first front-end framework for web-development, created by [Муекутлщ Ьфчшь](http://twitter.com/vmaxmert), and maintained by the [core team](https://github.com/maxmert?tab=members) with the support and involvement of the community.

To get started, check out <http://maxmertkit.com>!

## Table of contents

- [Quick start](#quick-start)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Documentation](#documentation)
- [Compiling CSS and JavaScript](#compiling-css-and-javascript)
- [Contributing](#contributing)
- [Community](#community)
- [Versioning](#versioning)
- [Authors](#authors)
- [Copyright and license](#copyright-and-license)

## Quick start

Three quick start options are available:

- [Download the latest release](https://github.com/maxmert/maxmertkit/archive/v1.0.0.zip).
- Clone the repo: `git clone https://github.com/maxmert/maxmertkit.git`.
- Install with [Bower](http://bower.io): `bower install maxmertkit`.

Read the [Start page](http://maxmertkit.com/start/) for information on the framework contents, templates and examples, and more.

### What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations.


## Bugs, errors and feature requests

Have a bug, text error or a feature request? Please first read the [issue guidelines](https://github.com/maxmert/maxmertkit/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/maxmert/maxmertkit/issues/new).


## Documentation

Maxmertkit's documentation, included in this repo in the root directory, is run with [Nodejs](http://nodejs.org). The docs may be run locally.

### Running documentation locally

1. If necessary, [install Nodejs](http://nodejs.org), [install NPM](http://npmjs.org), [install Bower](http://bower.io).
2. From the root `/maxmertkit` directory, run `npm install` in the command line.
3. Run `bower install` in the command line.
4. From the `/docs` directory, run `npm install` in the command line.
5. From the `/docs` directory, run `bower install` in the command line.
6. From the root `/maxmertkit` directory, run `gulp` in the command line.
7. Open <http://localhost:3333> in your browser.


### Documentation for previous releases

Documentation for v0.0.2 has been made available for the time being at <http://old.maxmertkit.com> while folks transition to Maxmertkit 1.0.0.



## Compiling CSS and JavaScript

Maxmertkit uses [Gulp](http://gulpjs.com/) with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Gulp commands.

### Install Gulp

From the command line:

1. Install `gulp` globally with `npm install -g gulp`.
2. Read about running documentation locally.

When completed, you'll be able to run the various Gulp commands provided from the command line.

**Unfamiliar with npm? Don't have node installed?** That's a-okay. npm stands for [node packaged modules](http://npmjs.org/) and is a way to manage development dependencies through node.js. [Download and install node.js](http://nodejs.org/download/) before proceeding.

### Available Gulp commands

#### Build and watch - `gulp`
Run `gulp` to run tests locally and compile the CSS and JavaScript into `/buil`. **Uses [Sass](http://sass-lang.org/) and [Coffeescript](http://coffeescript.org).**

#### Only compile CSS and JavaScript - `gulp build`
`gulp build` creates the `/build` directory with compiled files. **Uses [Less](http://lesscss.org/) and [UglifyJS](http://lisperator.net/uglifyjs/).**

#### Tests - `gulp test`


### Troubleshooting dependencies

Should you encounter problems with installing dependencies or running Gulp commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install` and `bower install` in the root and **/docs** directory.



## Contributing

Please read through our [contributing guidelines](https://github.com/maxmert/maxmertkit/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, please include relevant unit tests. All HTML and CSS should conform to the [Code Guide](http://github.com/mdo/code-guide), maintained by [Mark Otto](http://github.com/mdo).



## Community

Keep track of development and community news.

- Follow [@maxmertkit on Twitter](http://twitter.com/maxmertkit).
- Follow [@vmaxmert on Twitter](http://twitter.com/vmaxmert).
- Implementation help may be found at Stack Overflow (tagged [`maxmertkit-1`](http://stackoverflow.com/questions/tagged/maxmertkit-1)).




## Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Maxmertkit is maintained under the Semantic Versioning guidelines. Sometimes I screw up, but I'll adhere to these rules whenever possible.

Releases will be numbered with the following format:

`<major>.<minor>.<patch>`

And constructed with the following guidelines:

- Breaking backward compatibility **bumps the major** while resetting minor and patch
- New additions without breaking backward compatibility **bumps the minor** while resetting the patch
- Bug fixes and misc changes **bumps only the patch**

For more information on SemVer, please visit <http://semver.org/>.



## Creators

**Vetrenko Maxim**

- <http://twitter.com/vmaxmert>
- <http://github.com/maxmert>
- <http://facebook.com/vetrenko.maxim>



## Copyright and license

Code and documentation copyright 2012-2014 Maxmert. Code released under [the MIT license](LICENSE). Docs released under [Creative Commons](docs/LICENSE).

0 comments on commit 8687b46

Please sign in to comment.