henry/rust-password-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added CONTRIBUTING

Browse source
This commit is contained in:
ManOfGoldForever 2026-02-01 12:31:46 -05:00
parent e59a8b8d18
commit 2f6c9c4c54
2 changed files with 33 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

29
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,29 @@
# Contributing to pm 🦀
First, thanks for your interest in contributing to "pm"! Contributions are what make open-source so amazing.
## How Can I Contribute?
### Reporting Bugs
- Check the Issues tab to make sure the bug hasn't already been reported
- If it has not, open an issue with the label `bug` and describe the problem, your operating system, and steps to reproduce the bug.
### Suggesting Features
- Open an issue with the label `enhancement`.
- Describe the feature you'd like to see and why it would be useful. (e.g., "Add a cli to improve user experience").
### Pull Requests (Code Contributions)
- If you've fixed a bug, added a new feature, or even just fixed a README typo, you can submit a pull request with your changes.
- Make sure the code is easy to read and understand, include tests for new features or bug fixes and they all pass, and follow the Rust Style Guide (You can use the `cargo fmt` command to make sure it fits the style guide.)
- Also since this is a Rust project you will need the standard toolchain to run cargo commands like `cargo build`.
## Security Note
If you find a security vulnerability, please do not open a public issue and instead contact me directly so it can be fixed without being disclosed.
## License
By contributing, you agree that your contributions will be licensed under the project's MIT License.

4
README.md
View file

@ -100,6 +100,10 @@ This tool uses Argon2id to perform some black magic. So even if someone stole yo
I plan to add more to this eventually like maybe a secure password generator or a TUI or something, but I don't have a list of things to add yet. Maybe after using it some I will come up with some stuff we'll see what happens. I plan to add more to this eventually like maybe a secure password generator or a TUI or something, but I don't have a list of things to add yet. Maybe after using it some I will come up with some stuff we'll see what happens.
### Contributing
If you are interested in contributing to this project look at [CONTRIBUTING](./CONTRIBUTING.md) for more information on how you can.
### License ### License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.