Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info about our discord #9

Merged
merged 4 commits into from
Sep 26, 2024
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
22 changes: 22 additions & 0 deletions .github/changelog.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/usr/bin/env bash

m_branch=m;
changelog_file=CHANGELOG.md;

# fetch master since we might be in a shallow clone
git fetch origin "$m_branch:$m_branch" --depth=1

changed=0;
for log in */"$changelog_file"; do
dir=$(dirname "$log");
# check if version changed
if git diff "$m_branch" -- "$dir/Cargo.toml" | grep -q "^-version = "; then
# check if changelog updated
if git diff --exit-code --no-patch "$m_branch" -- "$log"; then
echo "$dir version changed, but $log is not updated"
changed=1;
fi
fi
done

exit "$changed";
41 changes: 37 additions & 4 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,51 @@ env:
CARGO_NET_GIT_FETCH_WITH_CLI: true

jobs:
build:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: Swatinem/rust-cache@v2
- name: Build
run: cargo build --release
with:
cache-on-failure: "true"
- name: Check all-features
run: cargo check
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: Swatinem/rust-cache@v2
with:
cache-on-failure: "true"
- name: Run tests
run: cargo test
fmt:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check formatting
run: cargo fmt --all -- --check
clippy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: Swatinem/rust-cache@v2
with:
cache-on-failure: "true"
- name: Run clippy
run: cargo clippy --all --lib -- --no-deps -D clippy::all -D clippy::unwrap_used -D clippy::expect_used
- name: Run clippy tests
clippy-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: Swatinem/rust-cache@v2
with:
cache-on-failure: "true"
- name: Run clippy
run: cargo clippy --tests -- -D clippy::all
check-changelog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check changelogs
run: ./.github/changelog.sh
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## v0.1.2
* Update links in the crate, add info about our discord to readme [#9]

[#9]: https://github.com/LFDT-Lockness/stark-curve/pull/9

## v0.1.1

Changes prior to this version weren't documented
14 changes: 11 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

Thanks for taking interest to contributing to our project!

## Join us in Discord!
We welcome all contributors to communicate with us [in Discord]! Please, reach out to us
in `#lockness-contribute` room.

## Pull Requests
Prior to making a PR, we ask you to communicate it with us, preferably by opening an issue.
This would help to keep your work aligned with the maintainers view and get insights from
them.
Prior to making a PR, we ask you to communicate it with us, either [in Discord] or, if you
prefer, by opening an issue in the repo. This would help to keep your work aligned with the
maintainers view and avoid situations in which we can't accept your contribution.

All commits are required to be signed via verified GPG key. You can read about commit signing
in [this series of articles](https://docs.github.com/en/authentication/managing-commit-signature-verification)
Expand Down Expand Up @@ -62,3 +66,7 @@ communicate with us for other reasons.
However, if you want to report something that you believe might be a security
vulnerability or a security flaw in this or any upstream project, please report
it following the procedure described in [SECURITY.md](./SECURITY.md).

Feel free to reach out to us [in Discord] as well.

[in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[package]
name = "stark-curve"
version = "0.1.1"
version = "0.1.2"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "Stark curve implementation"
repository = "https://github.com/dfns/stark-curve"
repository = "https://github.com/LFDT-Lockness/stark-curve"
categories = ["cryptography", "no-std", "no-std::no-alloc"]
keywords = ["elliptic-curves", "stark-curve"]

Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
![License](https://img.shields.io/crates/l/stark-curve.svg)
[![Docs](https://docs.rs/stark-curve/badge.svg)](https://docs.rs/stark-curve)
[![Crates io](https://img.shields.io/crates/v/stark-curve.svg)](https://crates.io/crates/stark-curve)
[![Discord](https://img.shields.io/discord/905194001349627914?logo=discord&logoColor=ffffff&label=Discord)][in Discord]

# Stark Curve

Expand Down Expand Up @@ -40,6 +41,11 @@ used and tested.
[ff]: https://crates.io/crates/ff
[elliptic-curve]: https://crates.io/crates/elliptic-curve

## Join us in Discord!
Feel free to reach out to us [in Discord]!

[in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388

## License

Licensed under either of
Expand Down
Loading