Skip to content

Commit 8a23a6a

Browse files
author
evombau
committed
init to github with license
1 parent 13ddde7 commit 8a23a6a

File tree

12 files changed

+249
-91
lines changed

12 files changed

+249
-91
lines changed

‎.examples/GitHub_Actions.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
## Installing Awesome-CI in GitHub Actions

‎.gitattributes‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/CHANGELOG.md merge=union

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Short description explaining the high-level reason for the new issue.
2+
3+
## Current behavior
4+
5+
6+
## Expected behavior
7+
8+
9+
## Steps to replicate behavior (include URLs)
10+
11+
1.
12+
13+
14+
## Screenshots
15+
16+
17+

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
[Short description explaining the high-level reason for the pull request]
2+
3+
## Additions
4+
5+
-
6+
7+
## Removals
8+
9+
-
10+
11+
## Changes
12+
13+
-
14+
15+
## Testing
16+
17+
1.
18+
19+
## Screenshots
20+
21+
22+
## Notes
23+
24+
-
25+
26+
## Todos
27+
28+
-
29+
30+
## Checklist
31+
32+
- [ ] PR has an informative and human-readable title
33+
- [ ] Changes are limited to a single goal (no scope creep)
34+
- [ ] Code can be automatically merged (no conflicts)
35+
- [ ] Code follows the standards laid out in the [development playbook](https://github.com/cfpb/development)
36+
- [ ] Passes all existing automated tests
37+
- [ ] Any _change_ in functionality is tested
38+
- [ ] New functions are documented (with a description, list of inputs, and expected output)
39+
- [ ] Placeholder code is flagged / future todos are captured in comments
40+
- [ ] Visually tested in supported browsers and devices (see checklist below :point_down:)
41+
- [ ] Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
42+
- [ ] Reviewers requested with the [Reviewers tool](https://help.github.com/articles/requesting-a-pull-request-review/) :arrow_right:
43+
44+
## Testing checklist
45+
46+
### Browsers
47+
48+
- [ ] Chrome
49+
- [ ] Firefox
50+
- [ ] Safari
51+
- [ ] Internet Explorer 8, 9, 10, and 11
52+
- [ ] Edge
53+
- [ ] iOS Safari
54+
- [ ] Chrome for Android
55+
56+
### Accessibility
57+
58+
- [ ] Keyboard friendly
59+
- [ ] Screen reader friendly
60+
61+
### Other
62+
63+
- [ ] Is useable without CSS
64+
- [ ] Is useable without JS
65+
- [ ] Flexible from small to large screens
66+
- [ ] No linting errors or warnings
67+
- [ ] JavaScript tests are passing

‎.gitignore‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,4 @@
1414
# Dependency directories (remove the comment below to include it)
1515
# vendor/
1616
out
17-
*.env
18-
go.sum
17+
*.env

‎.gitlab-ci.yml‎

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
All notable changes to this project will be documented in this file.
2+
We follow the [Semantic Versioning 2.0.0](http://semver.org/) format.
3+
4+
5+
## x.y.z - YYYY-MM-DD
6+
7+
### Added
8+
- Lorem ipsum dolor sit amet
9+
10+
### Deprecated
11+
- Nothing.
12+
13+
### Removed
14+
- Nothing.
15+
16+
### Fixed
17+
- Nothing.

‎CONTRIBUTING.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Guidance on how to contribute
2+
3+
> All contributions to this project will be released under the CC0 public domain
4+
> dedication. By submitting a pull request or filing a bug, issue, or
5+
> feature request, you are agreeing to comply with this waiver of copyright interest.
6+
> Details can be found in our [TERMS](TERMS.md) and [LICENSE](LICENSE).
7+
8+
9+
There are two primary ways to help:
10+
- Using the issue tracker, and
11+
- Changing the code-base.
12+
13+
14+
## Using the issue tracker
15+
16+
Use the issue tracker to suggest feature requests, report bugs, and ask questions.
17+
This is also a great way to connect with the developers of the project as well
18+
as others who are interested in this solution.
19+
20+
Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in
21+
the issue that you will take on that effort, then follow the _Changing the code-base_
22+
guidance below.
23+
24+
25+
## Changing the code-base
26+
27+
Generally speaking, you should fork this repository, make changes in your
28+
own fork, and then submit a pull request. All new code should have associated
29+
unit tests that validate implemented features and the presence or lack of defects.
30+
Additionally, the code should follow any stylistic and architectural guidelines
31+
prescribed by the project. In the absence of such guidelines, mimic the styles
32+
and patterns in the existing code-base.
33+
34+
35+
## Browser support
36+
37+
We configure our build chain tools
38+
(typically [Autoprefixer](https://github.com/postcss/autoprefixer)
39+
and [Babel](https://babeljs.io))
40+
to support a reasonable set of backward compatibility with older browsers.
41+
42+
Please read up on
43+
[our current browser support guidance](https://github.com/cfpb/development/blob/main/guides/browser-support.md)
44+
and follow it when contributing to this project.

‎LICENSE‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
MIT License
2+
3+
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:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
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.

‎README.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Awesome CI
2+
3+
**Description**: Put a meaningful, short, plain-language description of what
4+
this project is trying to accomplish and why it matters.
5+
Describe the problem(s) this project solves.
6+
Describe how this software can improve the lives of its audience.
7+
8+
Other things to include:
9+
10+
- **Technology stack**: Indicate the technological nature of the software, including primary programming language(s) and whether the software is intended as standalone or as a module in a framework or other ecosystem.
11+
- **Status**: Alpha, at release the [CHANGELOG](CHANGELOG.md) would be updated.
12+
13+
## Dependencies
14+
15+
This project works with standart go libraries
16+
17+
18+
## Usage
19+
20+
Download the latest [Release](https://gitlab.com/eksrvb/awesome-ci-semver/-/releases) or include the Docker container in your Multi stage Build.
21+
22+
23+
[GitHub Actions](.examples/GitHub_Actions.md)
24+
25+
Show users how to use the software.
26+
Be specific.
27+
Use appropriate formatting when showing code snippets.
28+
29+
## Installation
30+
31+
The installation is needed only for contirbuting.
32+
33+
Go to your GOPATH under `src/` and run: `git clone https://gitlab.com/eksrvb/awesome-ci-semver.git`
34+
35+
## How to test the software
36+
37+
If the software includes automated tests, detail how to run those tests.
38+
39+
## Known issues
40+
41+
There are no known Issues yet.
42+
43+
## Getting help
44+
45+
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
46+
47+
## Getting involved
48+
49+
This section should detail why people should get involved and describe key areas you are
50+
currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building
51+
important pieces, etc.
52+
53+
General instructions on _how_ to contribute should be stated with a link to [CONTRIBUTING](CONTRIBUTING.md).
54+
55+
56+
----
57+
58+
## Open source licensing info
59+
1. [TERMS](TERMS.md)
60+
2. [LICENSE](LICENSE)
61+
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
62+
63+
64+
----
65+
66+
## Credits and references
67+
68+
- [SemVer](https://semver.org/lang/de/)

0 commit comments

Comments
 (0)