Skip to content

Commit a2ce196

Browse files
committed
PR request template
1 parent 924a083 commit a2ce196

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

.github/pull_request_template.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Description
2+
3+
Briefly describe the changes in this pull request.
4+
5+
## Type of change
6+
7+
Please check the relevant option:
8+
9+
- [ ] Bug fix
10+
- [ ] New feature
11+
- [ ] Performance improvement
12+
- [ ] Documentation update
13+
- [ ] Refactor / cleanup
14+
15+
## Changes made
16+
17+
-
18+
-
19+
-
20+
21+
## Testing
22+
23+
Describe how you tested these changes:
24+
25+
- [ ] Existing tests pass
26+
- [ ] New tests added (if applicable)
27+
- [ ] Manual testing
28+
29+
## Checklist
30+
31+
- [ ] Code builds successfully
32+
- [ ] Public APIs are documented
33+
- [ ] Documentation updated (if needed)
34+
- [ ] No breaking changes (or clearly documented)
35+
36+
## Related issues
37+
38+
Closes # (if applicable)

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to lin_algebra
2+
3+
Thank you for your interest in contributing!
4+
5+
This project is open to:
6+
- bug fixes
7+
- performance improvements
8+
- documentation improvements
9+
- examples and tests
10+
11+
---
12+
13+
## How to contribute
14+
15+
1. Fork the repository
16+
2. Create a new branch from `main`
17+
3. Make your changes
18+
4. Open a Pull Request against `main`
19+
20+
Please keep pull requests focused and well-described.
21+
22+
---
23+
24+
## Development setup
25+
26+
```bash
27+
cargo build
28+
cargo test
29+
```
30+
31+
32+
## Code Style
33+
- Prefer clear names over clever code
34+
- Add docstrings for public methods
35+
- Add tests for new functionality when possible
36+
37+
## Question or ideas?
38+
Feel free to open an issue to discuss changes before starting work.

0 commit comments

Comments
 (0)