Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
salehkhazaei committed May 30, 2024
0 parents commit dadd715
Show file tree
Hide file tree
Showing 12 changed files with 376 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

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

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
45 changes: 45 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## Description
<!-- Provide a brief description of your changes -->

## What type of PR(Pull Request) is this?
- [ ] 🐛 Bug Fix
- [ ] 🍕 New Feature
- [ ] 🔥 Performance Improvement
- [ ] 📝 Documentation update
- [ ] ✅ Test
- [ ] 🤖 Build
- [ ] 📦 Release
- [ ] 🔁 CI/CD
## Added to documentation?
- [ ] 📜 README.md
- [ ] 🤝 CONTRIBUTING.md
- [ ] 🙅 no documentation needed

## Bug Fix
1. [ ] Explain how you addressed the issue.
2. [ ] Ensure the issue is linked in your description using "Fixes #XXXX."
## New Feature
1. [ ] Provide a clear explanation of your new feature.
2. [ ] Include relevant tests for the new feature.
3. [ ] Confirm successful local testing of your changes.
4. [ ] Update the relevant documentation (if applicable).
## Performance Improvement
1. [ ] Confirm successful local testing of the performance improvement.
2. [ ] If possible, include metrics demonstrating the improvement.

## General Notes
1. Ensure your PR is not a duplicate.
2. If not, make sure that:
1. Changes are in a separate branch with a descriptive name (e.g., `fix-cost-command` or `feature-add-newCommand`).
2. Commit message has a short, descriptive title.
3. **After** these steps,open a pull request.
1. Target the `contributor` branch, not `main`.
2. Resolve any GitHub workflow test errors before committing.
3. Include "closes #XXXX" in your comment to auto-close the relevant issue (if applicable).
3. Describe your changes.
4. Put the "closest #XXXX" text in your comment to auto-close the issue your PR is fixing (if such).

IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.


26 changes: 26 additions & 0 deletions .github/assets/Kaytu-New-Logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/kaytu.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions .github/assets/kaytu.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions .github/assets/kaytuIcon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
71 changes: 71 additions & 0 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Release

on:
push:
branches:
- main

jobs:
tag:
runs-on: ubuntu-latest
outputs:
latest_tag: ${{ steps.set_latest_tag.outputs.latest_tag }}
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GH_TOKEN }}
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: stable
- name: Tag version
id: tag_version
uses: mathieudutour/[email protected]
with:
github_token: ${{ secrets.GH_TOKEN }}
release_branches: main
tag_prefix: v
- name: Set latest tag output
id: set_latest_tag
run: |
if [[ -z "${{ steps.tag_version.outputs.new_tag }}" ]]; then
echo "latest_tag=${{ steps.tag_version.outputs.previous_tag }}" >> "$GITHUB_OUTPUT"
else
echo "latest_tag=${{ steps.tag_version.outputs.new_tag }}" >> "$GITHUB_OUTPUT"
fi
- name: Save new tag
id: save_new_tag
run: |
version=${{ steps.tag_version.outputs.new_tag }}
version=${version#v}
echo $version > new_tag.txt
- name: Upload new tag
uses: actions/upload-artifact@v2
with:
name: new_tag
path: new_tag.txt
release:
runs-on: ubuntu-latest
needs:
- tag
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GH_TOKEN }}
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: stable
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v5
with:
distribution: goreleaser
version: latest
args: release --clean
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.idea
.kaytu
cli
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<h1 align="center"> Welcome! Thank you for your interest in contributing to Kaytu </h1>

Thank you for considering contributing to our open source project! Taking a moment to review this document will not only streamline the contribution process but also foster a collaborative and effective environment for everyone involved.

Adhering to these guidelines demonstrates your respect for the time and effort invested by the developers who manage and contribute to this project. By following these recommendations, you contribute to a smoother collaboration, and in return, you can expect the same level of respect when your issues are addressed or your patches and features are assessed.

## Code guidelines
Client-Side Implementation with CLI (Cobra Packages)

When working on the client side, which is implemented using CLI through Cobra packages, refer to [this link](https://github.com/spf13/cobra) for guidance on adding new commands.
for adding new command :

1- cmd File Structure:

Inside the cmd directory, you'll find two main files: cost and ingestion. These files are directly related to the cost and ingestion commands in the CLI.

2- Cost and Ingestion Subsets:

Within the cmd directory, you can extend functionality by adding desired commands or flags to the cost and ingestion subsets. Follow the structure provided by Cobra packages for seamless integration.
Loading

0 comments on commit dadd715

Please sign in to comment.