Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# These are supported funding model platforms

github: [n4vrl0s3] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
github: [sha-wrks]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: yanshaaa # Replace with a single Ko-fi username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
Expand Down
49 changes: 49 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

env:
CARGO_TERM_COLOR: always

jobs:
test:
name: Test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Install Rust stable
uses: dtolnay/rust-toolchain@stable

- name: Cache dependencies
uses: Swatinem/rust-cache@v2

- name: Build
run: cargo build --verbose

- name: Run tests
run: cargo test --verbose

lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Install Rust stable
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy

- name: Cache dependencies
uses: Swatinem/rust-cache@v2

- name: Check formatting
run: cargo fmt --check

- name: Clippy
run: cargo clippy -- -D warnings
36 changes: 36 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Rust build output
/target/

# Cargo lock file (keep for binaries, remove this line if publishing as a library)
# Cargo.lock

# Editor and IDE
.vscode/settings.json
.vscode/launch.json
.vscode/tasks.json
.idea/
*.iml

# OS generated
.DS_Store
.DS_Store?
._*
.Spotlight-V8
.Trashes
ehthumbs.db
Thumbs.db
desktop.ini

# Environment and secrets
.env
.env.local
.env.*.local
*.pem
*.key

# Logs
*.log
!tests/fixtures/*.log

# Benchmark results
criterion/
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
n4vrl0s3@gmail.com.
All complaints will be reviewed and investigated promptly and fairly.
yansha@yansha.dev. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Expand Down Expand Up @@ -126,3 +125,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contribution Guide

Thank you for your interest in contributing to this project! Your contributions can help make this project better. Here are some guidelines to help you get started.

## How to Contribute

1. Fork this repository:
- Click the `Fork` button at the top of this repository page.
2. Clone the forked repository to your local machine.
```bash
git clone https://github.com/username/Log-Rift.git
```
- Replace `username` with your GitHub username.
3. Create a new branch
- Create a new branch for the feature or fix you want to add.
```
cd Log-Rift
git checkout -b your-branch-name
```
- Use a descriptive branch name that reflects the feature or fix you are working on.
4. Make the necessary changes:
- Add or modify your code.
5. Commit your changes:
- Make sure to write a clear and descriptive commit message.
```
git add .
git commit -m "Brief description of the changes you made"
```
6. Push to your repository:
- Push your branch to your GitHub repository.
```
git push origin your-branch-name
```
7. Create a Pull Request (PR):
- Go to the original repository page and create a pull request from your branch.
- Provide a clear description of what you added or fixed in your pull request.

## Coding Guidelines

- Follow a consistent coding standard: Ensure your code is consistent with the existing code style in this project.
- Write clear documentation: Add necessary comments and documentation to help others understand your code.
- Write tests: If possible, add tests for the features or fixes you are adding.

## Reporting Issues

If you find any bugs or have suggestions for improvements, please create a new issue on the Issues page.

## Communication

If you want to discuss something related to your contribution or the project in general, feel free to reach out to us via [Discussions](https://github.com/sha-wrks/Log-Rift/discussions).

<br>
Thank you for your contribution!
Loading
Loading