Skip to content

Commit f02f15d

Browse files
committed
1 parent 04b25f2 commit f02f15d

File tree

5 files changed

+90
-0
lines changed

5 files changed

+90
-0
lines changed

.github/dependabot.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "cargo" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "monthly"
12+
groups:
13+
dependencies:
14+
patterns:
15+
- "*"

.github/workflows/ci.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,10 @@ jobs:
4141
toolchain: ${{ matrix.toolchain }}
4242
- uses: Swatinem/rust-cache@v2
4343
- run: just test
44+
45+
audit:
46+
runs-on: ubuntu-latest
47+
steps:
48+
- uses: actions/checkout@v4
49+
- uses: taiki-e/install-action@cargo-audit
50+
- run: cargo audit -D warnings

CODE_OF_CONDUCT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Code of Conduct
2+
3+
This project follows the [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct).
4+
5+
**ADDITIONAL**: DO NOT submit anything about real world politics.
6+
7+
For example, the political statements in the pages below will be rejected.
8+
+ <https://blog.rust-lang.org/2020/06/04/Rust-1.44.0.html>
9+
+ <https://blog.rust-lang.org/2022/02/24/Rust-1.59.0.html>
10+
+ <https://blog.rust-lang.org/2022/11/03/Rust-1.65.0.html>

CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Development Guide
2+
3+
## Requirements
4+
5+
| Toolchain | Version |
6+
| :-----------------------------------: | :-----: |
7+
| [Rust](https://rustup.rs/) | ^1.74.0 |
8+
| [just](https://github.com/casey/just) | ^1.36.0 |
9+
10+
## Workflow
11+
12+
### Download source code
13+
14+
```bash
15+
git clone https://github.com/Nugine/std-next.git
16+
cd std-next
17+
```
18+
19+
### Run basic checks and tests
20+
21+
```bash
22+
just dev
23+
```
24+
25+
### Open documentation
26+
27+
```bash
28+
just doc
29+
```
30+
31+
### Run CI checks locally
32+
33+
```bash
34+
just ci
35+
```
36+
37+
## Git
38+
39+
### Commit Message
40+
41+
We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
42+
43+
### Pull Request
44+
45+
Before creating or updating a pull request, please make sure to run the following commands:
46+
47+
```bash
48+
just dev
49+
```
50+
51+
It's recommended to resolve any warnings or errors before submitting.
52+
53+
Note that some lints may be too restrict. You can allow some of them if you think they are not helpful to the code quality.

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,8 @@
1313
`stdx` - Opinionated utilities and polyfills.
1414

1515
Documentation: <https://docs.rs/std-next>
16+
17+
## Contributing
18+
19+
+ [Development Guide](./CONTRIBUTING.md)
20+
+ [Code of Conduct](./CODE_OF_CONDUCT.md)

0 commit comments

Comments
 (0)