Skip to content

Commit 2472b46

Browse files
j-g00daorhun
andauthored
docs(contributing): add contribution guidelines (#77)
* wip: contributing guidelines * wip: contributing guidelines * docs(contributing): expand about conventional commits and PR titles --------- Co-authored-by: Orhun Parmaksız <[email protected]>
1 parent 7e8ed6b commit 2472b46

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contribution guidelines
2+
3+
Thank you for considering contributing to Mousefood!
4+
5+
## Reporting issues
6+
7+
1. Before submitting a new issue, please search the
8+
[issue tracker](https://github.com/ratatui/mousefood/issues) using relevant
9+
keywords to ensure it hasn't already been reported.
10+
11+
## Pull requests
12+
13+
1. Please include as much detail as possible in your pull request description
14+
and follow the provided template. Be sure to highlight any changes that may
15+
need special attention or that you're unsure about.
16+
2. If your idea could significantly impact the crate or its users, it's best to
17+
discuss it in an issue first.
18+
3. Try to keep each pull request focused on a single change.
19+
4. Avoid mixing refactoring or reformatting with behavioral changes. Consider
20+
splitting such changes into separate PRs.
21+
5. Run `cargo fmt` before committing.
22+
6. Use Conventional Commits for commit messages (for example, `feat: add foo`
23+
or `fix: handle bar edge case`).
24+
7. Keep PR titles concise and aligned with Conventional Commits so they are
25+
easy to scan (for example, `docs: update contributing`).

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ use mousefood::prelude::*;
3232
fn main() -> Result<(), std::io::Error> {
3333
// Any embedded_graphics DrawTarget
3434
let mut display = MyDrawTarget::new();
35-
35+
3636
let backend = EmbeddedBackend::new(&mut display, EmbeddedBackendConfig::default());
3737
let mut terminal = Terminal::new(backend)?;
3838

@@ -153,6 +153,12 @@ Successfully tested on:
153153

154154
Full API docs are available on [docs.rs](https://docs.rs/mousefood).
155155

156+
## Contributing
157+
158+
All contributions are welcome!
159+
160+
Before opening a pull request, please read the [contributing guidelines](./CONTRIBUTING.md).
161+
156162
## Built with Mousefood
157163

158164
Here are some projects built using Mousefood:

0 commit comments

Comments
 (0)