Skip to content
This repository has been archived by the owner on Dec 26, 2022. It is now read-only.

Commit

Permalink
Initial release (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
isuPatches committed Jul 23, 2021
1 parent 132535f commit 5995e80
Show file tree
Hide file tree
Showing 87 changed files with 3,298 additions and 237 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[*.{kt,kts}]
max_line_length = 120
ij_continuation_indent_size = 4
24 changes: 24 additions & 0 deletions .githooks/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/bin/bash
echo "Running ktlintCheck"
if ! ktlintStatus=$(./gradlew --parallel --max-workers=4 ktlintCheck); then
echo "Ktlint must pass before commit!"
exit "$ktlintStatus"
fi

echo "Running detekt"
if ! detektStatus=$(./gradlew --parallel --max-workers=4 detekt); then
echo "Detekt must pass before commit!"
exit "$detektStatus"
fi

echo "Running lint"
if ! lintStatus=$(./gradlew --parallel --max-workers=4 lintDebug); then
echo "Lint must pass before commit!"
exit "$lintStatus"
fi

echo "Running cpd"
if ! cpdStatus=$(./gradlew --parallel --max-workers=4 cpdCheck); then
echo "CPD must pass before commit!"
exit "$cpdStatus"
fi
60 changes: 60 additions & 0 deletions .githooks/pre-push
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
#!/bin/bash

directories=("viewglu")
for directory in "${directories[@]}"; do
if [[ -d "documentation/$directory" ]] ; then
echo "Removing documentation/$directory"
rm -r "documentation/$directory"
fi
done

if [[ -f "documentation/index.md" ]] ; then
echo "Removing documentation/index.md"
rm -f "documentation/index.md"
fi

echo "Regenerating documentation"
if ! dokkaStatus=$(./gradlew dokkaGfm); then
echo "Dokka must be successful before pushing!"
exit "$dokkaStatus"
fi

parentBranch=""
branch=$(git branch --show-current)

git log --max-count=100 --oneline --decorate=full | {
while read -r line; do

echo "line: $line"

if [[ $line == *"origin/$branch"* ]]; then
dest=$(echo "$line" | awk '{ print $2 }')
echo "Found local destination as $dest"
# DO NOT BREAK HERE
fi

if [[ $line == *"remotes/origin/develop"* ]]; then
parentBranch='develop'
break
fi
if [[ $line == *"remotes/origin/production"* ]]; then
parentBranch='production'
break
fi

if [[ $line == *"remotes/origin/main"* ]]; then
parentBranch='main'
break
fi
done

echo "Diffing $branch against parentBranch"
diff=$(git rev-list --left-only --count origin/"$parentBranch"..."$branch")

if [[ $diff == 0 ]]; then
echo "Looks like you're up to date!"
else
echo "You're behind by $diff commits! Please rebase before pushing!"
exit 1
fi
}
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* @isuPatches
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug Report
about: Create a report to help us improve

---

Thank you for creating an issue to improve this library! Please check [the current issues](https://github.com/isupatches/android-viewglu/issues) to make sure that the fix isn't already being worked on.

It will be _EXTREMELY_ helpful if you also take a look at the [sample app](/app) to see how it behaves and if you can reproduce there.

**Description**
A clear and concise description of the bug.

**Additional Context**
Add any other context about the bug here.

**Screenshots**
If applicable, add screenshots to help explain.

**Steps To Reproduce**
Steps to reproduce the behavior.

**Expected Behavior**
A description of what you expected to happen.

**Actual Behavior**
A description of what actually happened.

**Additional Information**
- Device (f.e. Nexus 5x):
- OS Version (f.e. Android 8.1):
- Rooted:
- Reproducible with sample app?:
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature Request
about: Suggest an idea for this project

---

Thank you for creating an issue to improve this library! Please check [the current issues](https://github.com/isupatches/android-viewglu/issues) to make sure that the feature isn't already being worked on.

**Description**
A clear and concise high-level description of the request. (f.e. As a developer I want ___ so that ___)

**Reason**
A brief explanation as to why it matters to you and your project.

**Acceptance Criteria**
Describe in more detail the request. (f.e. - a method is added to the library, - the method when called does ___, etc.)

**Additional context**
Add any other context about the request here.

**Images**
If applicable, add relevant images to help explain.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@
.externalNativeBuild
.cxx
local.properties
keystore.properties
/.idea/deploymentTargetDropDown.xml
132 changes: 132 additions & 0 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions .idea/codeStyles/codeStyleConfig.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions .idea/gradle.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions .idea/jarRepositories.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions .idea/kotlinScripting.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog

## [Unreleased]

##### Enhancements

##### Bug Fixes

##### Breaking

## 1.0.0

Initial release
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
I'd love to have your help, but please don't skimp on greatness!

Please check the [Issues](https://github.com/isupatches/android-viewglu/issues) and the [Main Board](https://github.com/isuPatches/android-viewglu/projects/1) to make sure what you want is not already being worked on.

* Please create an issue and use the [Main Board](https://github.com/isuPatches/android-viewglu/projects/1) to denote its status
- Please tag the issue with the appropriate labels as well (i.e. status, bug, TODO, etc.)
- Each issue should have clear details (i.e. steps to reproduce if it's a bug or acceptance criteria if a new feature)
* Please branch off develop to do any new work
- Branches should be prefixed with issue-# and a short description
* Please make sure all static code analysis checks pass
* Please write tests
* Please make sure current tests pass
* Please help maintain the KDocs and write new ones
* Once satisfied with your work, please submit a Pull Request and I'll be happy to review it! All PRs need to be reviewed by a code owner.

For merging:

* PRs will be squashed and merged after a rebase
- The commit should have issue-# in its description
- [Signed commits](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits) are required
- The branch must be up-to-date before merging
Loading

0 comments on commit 5995e80

Please sign in to comment.