Skip to content

Commit

Permalink
Remove dist, add open source documents, update package.json and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joswhite committed Aug 16, 2017
1 parent 3595665 commit d203b53
Show file tree
Hide file tree
Showing 14 changed files with 131 additions and 3,102 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
List any bug fixes and breaking changes here along with the version in which they were committed.
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [1.0.0] - 2017-xx-xx (Coming soon)
73 changes: 73 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Contributing to ias-icons

We would love for you to contribute to ias-icons and help to make our project
more stable and complete! As a contributor, here are the guidelines we would
like you to follow:

## Bugs and Feature Requests

If you find a bug or would like to request a new feature, open an issue on our GitHub repository.
Before doing so, search through the GitHub issue tracker to make sure there are no identical
issues already on GitHub.

### Bugs

For bugs, please provide an example in which ias-icons fails to perform as expected. This example
should contain only as much code as is necessary to demonstrate the problem. Continue extracting
code out of your example until it is as simple as possible. We will insist on minimal examples
to save maintainers time and ultimately be able to fix more bugs. Interestingly, many users often
find problems in their own code while preparing a simple example.

If you can determine the source of the bug yourself, you can help expedite this process by submitting
a Pull Request with a fix. See the Submission Guidelines section below.

### Feature Requests

You can request a new feature by submitting an issue on GitHub. Through the issue thread we will
discuss and approve the new feature before proceeding. After the feature request has been approved
work on the new feature can begin. In this way you can avoid the frustration and lost time of
implementing a new feature only to have it rejected because it does not match the project vision.

## Submission Guidelines

### Submitting a Pull Request

After forking the repository, create a branch from your fork of the repository following
[GitHub Flow](https://guides.github.com/introduction/flow/) standards. Create the branch from the
`development` branch. Prefix the branch name by its type: feature, bugfix, hotfix, or release.
For example:

$ git checkout -b feature/icon-button development

As you work, please make sure you follow correct coding practices and Typescript types. Write
good commit messages that meaningfully explain the changes made to the code.
Once you have committed your changes, open a pull request on GitHub to merge the changes from your
fork into the `development` branch of this repository.

### Coding Rules

- Adhere to tslint rules. Running the build command will alert you if any tslint rules have been
broken. Be sure to fix broken rules before committing your changes.
- Include Typescript types, except where
[inferred](https://www.typescriptlang.org/docs/handbook/type-inference.html).
Use interfaces to enforce object and class types. Begin interface names with an "I".
- Indentation: Use 2 spaces for `scss` files; 4 spaces for `ts`, `js`, and `html` files.
- Dot notation: Longer statements including the dot operator more than once should be split across
lines. Begin each new dot on a separate line and align it with the previous line.
- Write attractive code. Alphabetize variables and object properties where possible.

## Code of Conduct

- Be kind and courteous. Communication must be constructive and never resort to personal
attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
- Respect everyone involved in this project regardless of gender, sexual orientation, disability,
ethnicity, religion, or level of experience.
- Be considerate of other's opinions. Remember that each design or implementation choice carries
with it costs and trade-offs. Be willing to change your course of action in order to match the
project vision.
- Avoid unstructured critique as much as possible. If you have solid ideas you want to experiment
with, make a fork and see how it works.
- If any member of this community violates this code of conduct, they may be excluded from
interaction and their issues, comments, and PRs may be removed as deemed appropriate.
- If you are subject to or witness unacceptable behavior, please notify a developer working on
this project so we can take necessary action.
29 changes: 29 additions & 0 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Setting up the Developer Environment

1. Clone the repository and install packages via NPM

git clone [email protected]:jedwardhawkins/ias-icons.git
npm install -g gulp-cli
npm install

2. Build the project

~/ias-icons# gulp

In a new terminal:

~/ias-icons# cd docs
~/ias-icons/docs# gulp

3. Navigate to localhost:8080 to view the application.

## Build Command Explanation

This project uses [gulp.js](https://gulpjs.com/) and
[ng-gulp](https://github.com/jedwardhawkins/ng-gulp) to build ias-icons as well as the documentation
site for it. Running gulp tasks from the project root builds ias-icons. Running gulp tasks from
`/docs` inside the project root builds the documentation site for ias-icons, which can be viewed on
localhost:8080. Running `gulp` builds and serves the given application, watching the files for
changes and recompiling as necessary. (This command doesn't serve ias-icons since it does not have
any content to be served.) For a one-time build, run `gulp build:production`. To simply serve
files, run `gulp serve:production`.
14 changes: 14 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Copyright (c) 2017 Micro Focus

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.
Empty file removed LICENSE.md
Empty file.
Binary file removed dist/fonts/ias-icons.eot
Binary file not shown.
Loading

0 comments on commit d203b53

Please sign in to comment.