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
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ $ rust-code-analysis-cli -p src/algorithm/neighbour/fastpair.rs --ls 22 --le 213

* **read history**: search past open or closed issues for your problem before opening a new issue.

* **PRs on develop**: any change should be PRed first in `development`
* **PRs on main**: any change should be PRed first in `main`

* **testing**: everything should work and be tested as defined in the workflow. If any is failing for non-related reasons, annotate the test failure in the PR comment.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Fixes #

### Checklist
- [ ] My branch is up-to-date with development branch.
- [ ] My branch is up-to-date with main branch.
- [ ] Everything works and tested on latest stable Rust.
- [ ] Coverage and Linting have been applied

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: CI

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

jobs:
tests:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Coverage

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

jobs:
coverage:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Lint checks

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


jobs:
Expand Down
4 changes: 2 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Agent-focused guidance for working on the `smartcore` Rust machine-learning libr

- **Language / edition**: Rust 2024 (MSRV 1.85 — verified by the `msrv` CI job).
- **Repository**: https://github.com/smartcorelib/smartcore
- **Default branch**: `development`. All changes should target `development` first.
- **Default branch**: `main`. All changes should target `main` first.
- **License**: Apache-2.0.
- **Authors**: "smartcore Developers".

Expand Down Expand Up @@ -72,7 +72,7 @@ When touching feature-gated code, run at least `cargo build --all-features` and

- Open an issue describing the change before starting significant work.
- Search open and closed issues/PRs for related discussion.
- Open PRs against the `development` branch.
- Open PRs against the `main` branch.
- Use the PR template (`.github/PULL_REQUEST_TEMPLATE.md`) and erase sections that do not apply.
- Update `CHANGELOG.md` for breaking changes, new environment variables, exposed ports, useful file locations, and container parameters.
- Ensure CI checks pass:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Add to Cargo.toml:
smartcore = "^0.6"
```

For the latest development branch:
For the latest changes from the `main` branch:

```toml
[dependencies]
smartcore = { git = "https://github.com/smartcorelib/smartcore", branch = "development" }
smartcore = { git = "https://github.com/smartcorelib/smartcore", branch = "main" }
```

Optional features (examples):
Expand Down Expand Up @@ -147,7 +147,7 @@ Open the URLs above in a browser. Each page shows a searchable line chart (`data
Contributions are welcome:

- Open an issue describing the change and link it in the PR.
- Keep PRs in sync with the development branch and ensure tests pass on stable Rust (MSRV 1.85, edition 2024).
- Keep PRs in sync with the main branch and ensure tests pass on stable Rust (MSRV 1.85, edition 2024).
- Provide or update tests; run clippy and apply formatting. Coverage and linting are part of the workflow.
- Use the provided PR and issue templates to describe behavior changes, new features, and expectations.

Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@
//! smartcore = "*"
//! ```
//!
//! To start using smartcore development version with latest unstable additions:
//! To start using smartcore latest additions from the `main` branch:
//! ```ignore
//! [dependencies]
//! smartcore = { git = "https://github.com/smartcorelib/smartcore", branch = "development" }
//! smartcore = { git = "https://github.com/smartcorelib/smartcore", branch = "main" }
//! ```
//!
//! There are different features that can be added to the base library, for example to add sample datasets:
Expand Down
Loading