You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Contributing to CoreUI Free Angular Admin Template
2
+
3
+
Looking to contribute something to CoreUI Free Angular Admin Template? **Here's how you can help.**
4
+
5
+
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
6
+
7
+
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.
8
+
9
+
## Using the issue tracker
10
+
11
+
The [issue tracker](https://github.com/coreui/coreui-free-angular-admin-template/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:
12
+
13
+
* Please **do not** use the issue tracker for personal support requests.
14
+
15
+
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
16
+
Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
17
+
instead.
18
+
19
+
* Please **do not** open issues or pull requests regarding the code in [`@coreui/coreui`](https://github.com/coreui/coreui) and [`@coreui/coreui-angular`](https://github.com/coreui/coreui) (open them in their respective repositories).
20
+
21
+
## Bug reports
22
+
23
+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
24
+
Good bug reports are extremely helpful, so thanks!
25
+
26
+
Guidelines for bug reports:
27
+
28
+
0.**Validate and lint your code**— to ensure your problem isn't caused by a simple error in your own code.
29
+
30
+
1.**Use the GitHub issue search**— check if the issue has already been reported.
31
+
32
+
2.**Check if the issue has been fixed**— try to reproduce it using the latest `master` or development branch in the repository.
33
+
34
+
3.**Isolate the problem**— ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a live example. [This JS Bin](http://jsbin.com/lefey/1/edit?html,output) is a helpful template.
35
+
36
+
37
+
A good bug report shouldn't leave others needing to chase you up for more
38
+
information. Please try to be as detailed as possible in your report. What is
39
+
your environment? What steps will reproduce the issue? What browser(s) and OS
40
+
experience the problem? Do other browsers show the bug differently? What
41
+
would you expect to be the outcome? All these details will help people to fix
42
+
any potential bugs.
43
+
44
+
Example:
45
+
46
+
> Short and descriptive example bug report title
47
+
>
48
+
> A summary of the issue and the browser/OS environment in which it occurs. If
49
+
> suitable, include the steps required to reproduce the bug.
50
+
>
51
+
> 1. This is the first step
52
+
> 2. This is the second step
53
+
> 3. Further steps, etc.
54
+
>
55
+
> `<url>` - a link to the reduced test case
56
+
>
57
+
> Any other information you want to share that is relevant to the issue being
58
+
> reported. This might include the lines of code that you have identified as
59
+
> causing the bug, and potential solutions (and your opinions on their
60
+
> merits).
61
+
62
+
## Feature requests
63
+
64
+
Feature requests are welcome. Before opening a feature request, please take a moment to find out whether your idea
65
+
fits with the scope and aims of the project. It's up to *you* to make a strong
66
+
case to convince the project's developers of the merits of this feature. Please
67
+
provide as much detail and context as possible.
68
+
69
+
70
+
## Pull requests
71
+
72
+
Good pull requests—patches, improvements, new features—are a fantastic
73
+
help. They should remain focused in scope and avoid containing unrelated
74
+
commits.
75
+
76
+
**Please ask first** before embarking on any significant pull request (e.g.
77
+
implementing features, refactoring code, porting to a different language),
78
+
otherwise you risk spending a lot of time working on something that the
79
+
project's developers might not want to merge into the project.
80
+
81
+
Adhering to the following process is the best way to get your work
82
+
included in the project:
83
+
84
+
1.[Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
85
+
and configure the remotes:
86
+
87
+
```bash
88
+
# Clone your fork of the repo into the current directory
feature to tidy up your commits before making them public.
115
+
116
+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
117
+
118
+
```bash
119
+
git pull [--rebase] upstream master
120
+
```
121
+
122
+
6. Push your topic branch up to your fork:
123
+
124
+
```bash
125
+
git push origin <topic-branch-name>
126
+
```
127
+
128
+
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `master` branch.
129
+
130
+
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to license your work under the terms of the [MIT License](LICENSE).
131
+
132
+
### Semantic Git commit messages
133
+
134
+
Inspired by Sparkbox's awesome article on [semantic commit messages](http://seesparkbox.com/foundry/semantic_commit_messages). Please use following commit message format.
135
+
136
+
* chore (updating npm tasks etc; no production code change) -> ```git test -m 'chore: commit-message-here'```
* test (adding missing tests, refactoring tests; no production code change) -> ```git test -m 'refactor: commit-message-here'```
143
+
144
+
145
+
## Code guidelines
146
+
147
+
### HTML
148
+
149
+
[Adhere to the Code Guide.](http://codeguide.co/#html)
150
+
151
+
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
152
+
- 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://`.
153
+
- Use [WAI-ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes in documentation examples to promote accessibility.
154
+
155
+
### CSS
156
+
157
+
[Adhere to the Code Guide.](http://codeguide.co/#css)
158
+
159
+
- When feasible, default color palettes should comply with [WCAG color contrast guidelines](http://www.w3.org/TR/WCAG20/#visual-audio-contrast).
160
+
- 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.
161
+
162
+
### JS
163
+
164
+
- No semicolons (in client-side JS)
165
+
- 2 spaces (no tabs)
166
+
- strict mode
167
+
- "Attractive"
168
+
- Don't use [jQuery event alias convenience methods](https://github.com/jquery/jquery/blob/master/src/event/alias.js) (such as `$().focus()`). Instead, use [`$().trigger(eventType, ...)`](http://api.jquery.com/trigger/) or [`$().on(eventType, ...)`](http://api.jquery.com/on/), depending on whether you're firing an event or listening for an event. (For example, `$().trigger('focus')` or `$().on('focus', function (event) { /* handle focus event */ })`) We do this to be compatible with custom builds of jQuery where the event aliases module has been excluded.
169
+
170
+
## License
171
+
172
+
By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).
Please help us on [Product Hunt](https://www.producthunt.com/posts/coreui-open-source-bootstrap-4-admin-template-with-angular-2-react-js-vue-js-support) and [Designer News](https://www.designernews.co/stories/81127). Thanks in advance!
4
4
@@ -14,6 +14,7 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
14
14
15
15
*[Versions](#versions)
16
16
*[CoreUI Pro](#coreui-pro)
17
+
*[Admin Templates built on top of CoreUI Pro](#admin-templates-built-on-top-of-coreui-pro)
17
18
*[Installation](#installation)
18
19
*[Usage](#usage)
19
20
*[What's included](#whats-included)
@@ -28,11 +29,13 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
66
-
67
-
You can configure the default HTTP host and port used by the development server with two command-line options :
68
-
69
-
```bash
70
-
ng serve --host 0.0.0.0 --port 4201
71
-
```
72
-
73
-
### Generating Components, Directives, Pipes and Services
74
-
75
-
You can use the `ng generate` (or just `ng g`) command to generate Angular components:
76
74
77
-
```bash
78
-
ng generate component my-new-component
79
-
ng g component my-new-component # using the alias
80
-
81
-
# components support relative path generation
82
-
# if in the directory src/app/feature/ and you run
83
-
ng g component new-cmp
84
-
# your component will be generated in src/app/feature/new-cmp
85
-
# but if you were to run
86
-
ng g component ./newer-cmp
87
-
# your component will be generated in src/app/newer-cmp
88
-
# if in the directory src/app you can also run
89
-
ng g component feature/new-cmp
90
-
# and your component will be generated in src/app/feature/new-cmp
91
-
```
92
-
You can find all possible blueprints in the table below:
93
-
94
-
Scaffold | Usage
95
-
--- | ---
96
-
[Component](https://github.com/angular/angular-cli/wiki/generate-component) | `ng g component my-new-component`
97
-
[Directive](https://github.com/angular/angular-cli/wiki/generate-directive) | `ng g directive my-new-directive`
98
-
[Pipe](https://github.com/angular/angular-cli/wiki/generate-pipe) | `ng g pipe my-new-pipe`
99
-
[Service](https://github.com/angular/angular-cli/wiki/generate-service) | `ng g service my-new-service`
100
-
[Class](https://github.com/angular/angular-cli/wiki/generate-class) | `ng g class my-new-class`
101
-
[Guard](https://github.com/angular/angular-cli/wiki/generate-guard) | `ng g guard my-new-guard`
102
-
[Interface](https://github.com/angular/angular-cli/wiki/generate-interface) | `ng g interface my-new-interface`
103
-
[Enum](https://github.com/angular/angular-cli/wiki/generate-enum) | `ng g enum my-new-enum`
104
-
[Module](https://github.com/angular/angular-cli/wiki/generate-module) | `ng g module my-module`
105
-
106
-
angular-cli will add reference to `components`, `directives` and `pipes` automatically in the `app.module.ts`. If you need to add this references to another custom module, follow this steps:
107
-
108
-
1.`ng g module new-module` to create a new module
109
-
2. call `ng g component new-module/new-component`
110
-
111
-
This should add the new `component`, `directive` or `pipe` reference to the `new-module` you've created.
112
-
113
-
### Build
114
-
115
-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
116
-
117
-
```bash
118
75
# build for production with minification
119
76
$ ng build
120
77
```
@@ -124,38 +81,36 @@ $ ng build
124
81
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
125
82
126
83
```
127
-
free-bootstrap-admin-template/
84
+
free-angular-admin-template/
128
85
├── e2e/
129
86
├── src/
130
87
│ ├── app/
131
88
│ ├── assets/
89
+
│ ├── environments/
132
90
│ ├── scss/
133
-
│ ├── vendors/
134
-
│ ├── ...
135
91
│ ├── index.html
136
92
│ └── ...
137
93
├── .angular-cli.json
138
-
├── package.json
139
94
├── ...
140
-
├── tsconfig.json
95
+
├── package.json
141
96
└── ...
142
97
```
143
98
144
99
## Documentation
145
100
146
-
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for Angular](https://coreui.io/angular/)
101
+
The documentation for the CoreUI Free Angularp Admin Template is hosted at our website [CoreUI](https://coreui.io/angular/)
147
102
148
103
## Contributing
149
104
150
-
Please read through our [contributing guidelines](https://github.com/coreui/free-angular-admin-template/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
105
+
Please read through our [contributing guidelines](https://github.com/coreui/coreui-free-angular-admin-template/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
151
106
152
-
Editor preferences are available in the [editor config](https://github.com/coreui/free-angular-admin-template/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
107
+
Editor preferences are available in the [editor config](https://github.com/coreui/coreui-free-angular-admin-template/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
153
108
154
109
## Versioning
155
110
156
111
For transparency into our release cycle and in striving to maintain backward compatibility,CoreUI Free Admin Template is maintained under [the Semantic Versioning guidelines](http://semver.org/).
157
112
158
-
See [the Releases section of our project](https://github.com/coreui/free-angular-admin-template/releases) for changelogs for each release version.
113
+
See [the Releases section of our project](https://github.com/coreui/coreui-free-angular-admin-template/releases) for changelogs for each release version.
159
114
160
115
## Creators
161
116
@@ -172,7 +127,7 @@ See [the Releases section of our project](https://github.com/coreui/free-angular
172
127
173
128
Get updates on CoreUI's development and chat with the project maintainers and community members.
174
129
175
-
- Follow [@coreuikit on Twitter](https://twitter.com/coreuikit).
130
+
- Follow [@core_ui on Twitter](https://twitter.com/core_ui).
176
131
- Read and subscribe to [CoreUI Blog](https://coreui.ui/blog/).
177
132
178
133
### Community Projects
@@ -184,7 +139,7 @@ Some of projects created by community but not maintained by CoreUI team.
184
139
185
140
## Copyright and license
186
141
187
-
copyright 2018 creativeLabs Łukasz Holeczek. Code released under [the MIT license](https://github.com/coreui/free-angular-admin-template/blob/master/LICENSE).
142
+
copyright 2018 creativeLabs Łukasz Holeczek. Code released under [the MIT license](https://github.com/coreui/coreui-free-angular-admin-template/blob/master/LICENSE).
188
143
There is only one limitation you can't can’t re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In past we faced some problems with persons who tried to sell CoreUI based templates.
0 commit comments