Skip to content

Commit

Permalink
Merge pull request #4 from nao1215/nchika/contribution
Browse files Browse the repository at this point in the history
Introduce CONTRIBUTING  files
  • Loading branch information
nao1215 authored Jul 20, 2024
2 parents c25ae65 + 0b9f805 commit e43ca05
Show file tree
Hide file tree
Showing 6 changed files with 91 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG Report] "
labels: bug
assignees: ''

---

## gup version**
v0.y.z

## Description (About the problem)
A clear description of the bug encountered.

## Steps to reproduce
Steps to reproduce the bug.

## Expected behavior
Expected behavior.

## Additional details**
Any other useful data to share.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

## Is your feature request related to a problem?
A clear and concise description of what the problem is. E.g. I'm always frustrated when ...

## Describe the solution you'd like
A clear and concise description of what you want to happen.

## Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

## Additional context
Add any other context or screenshots about the feature request here.
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Please approach others with respect. That is everything.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Contributing as a Developer
- When creating a bug report: Please follow the template and provide detailed information.
- When fixing a feature: Create a Pull Request (PR) with accompanying test code.
- When adding a feature: First, propose the feature in an Issue.

## Contributing Outside of Coding
The following actions help boost my motivation:

- Giving a GitHub Star
- Promoting the application
- Becoming a GitHub Sponsor
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,18 @@ $ ./target/debug/cic --principal 1000000 --contribution 100000 --rate 10 --years
## License
MIT

## Contributing
First off, thanks for taking the time to contribute! ❤️ See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
Contributions are not only related to development. For example, GitHub Star motivates me to develop!

[![Star History Chart](https://api.star-history.com/svg?repos=nao1215/cic&type=Date)](https://star-history.com/#nao1215/cic&Date)

## Side note

The cic command is my first project in Rust. I am using it to learn how to write and structure projects in Rust.

### Why did I choose the theme of compound interest?

In Japan, the small amount investment tax exemption system (NISA) started gaining traction in 2024. I was fortunate enough to get involved in a NISA app at work.

This led me to develop an interest in investments. So, it's not surprising that I chose compound interest as my theme.
21 changes: 21 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Security Policy

## Reporting a Vulnerability

If you discover any security-related issues or vulnerabilities, please contact us at [[email protected]](mailto:[email protected]). We appreciate your responsible disclosure and will work with you to address the issue promptly.

## Supported Versions

We recommend using the latest release for the most up-to-date and secure experience. Security updates are provided for the latest stable version.

## Security Policy

- Security issues are treated with the highest priority.
- We follow responsible disclosure practices.
- Fixes for security vulnerabilities will be provided in a timely manner.

## Acknowledgments

We would like to thank the security researchers and contributors who responsibly report security issues and work with us to make our project more secure.

Thank you for your help in making our project safe and secure for everyone.

0 comments on commit e43ca05

Please sign in to comment.