Skip to content

Commit 71f04e3

Browse files
dadachidadachi
committed
add LICENCE
1 parent 108ea92 commit 71f04e3

4 files changed

Lines changed: 112 additions & 1 deletion

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Code of Conduct
2+
3+
This project adopts the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) as its Code of Conduct.
4+
5+
The full text is available at:
6+
https://www.contributor-covenant.org/version/2/1/code_of_conduct/
7+
8+
## Reporting
9+
10+
Instances of unacceptable behavior may be reported to the project maintainer at **maurois@mac.com**. All complaints will be reviewed and investigated promptly and fairly.
11+
12+
The maintainer is obligated to respect the privacy and security of the reporter of any incident.
13+
14+
## Enforcement
15+
16+
Maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

‎CONTRIBUTING.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing to NativeAppTemplate API
2+
3+
Thanks for your interest in contributing! This document explains how to report issues, propose changes, and submit pull requests.
4+
5+
## Code of Conduct
6+
7+
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold it.
8+
9+
## Reporting Bugs
10+
11+
Before opening an issue, please:
12+
13+
1. Search existing [issues](https://github.com/nativeapptemplate/nativeapptemplateapi/issues) to avoid duplicates.
14+
2. Confirm the bug reproduces on the `main` branch.
15+
3. Include:
16+
- Ruby and Rails versions (`ruby -v`, `bin/rails -v`)
17+
- PostgreSQL version
18+
- Steps to reproduce
19+
- Expected vs actual behavior
20+
- Relevant log output or stack traces
21+
22+
## Reporting Security Vulnerabilities
23+
24+
**Do not open public issues for security vulnerabilities.** See [SECURITY.md](SECURITY.md) for the disclosure process.
25+
26+
## Proposing Changes
27+
28+
For non-trivial changes, please open an issue first to discuss the approach before investing implementation time.
29+
30+
## Pull Requests
31+
32+
1. Fork the repository and create a feature branch from `main`.
33+
2. Make your changes with clear, focused commits.
34+
3. Add or update tests for any behavioral changes.
35+
4. Run the full test suite locally:
36+
```bash
37+
bin/rails test
38+
```
39+
5. Run the linter and security scanner:
40+
```bash
41+
bin/rubocop
42+
bin/brakeman --no-pager
43+
```
44+
6. Push your branch and open a pull request against `main`.
45+
7. In the PR description, explain *what* changed and *why*.
46+
47+
### Style
48+
49+
This project uses [RuboCop with the Rails Omakase style](https://github.com/rails/rubocop-rails-omakase). Please ensure `bin/rubocop` passes before submitting.
50+
51+
### Tests
52+
53+
- Tests use Minitest with parallel execution.
54+
- Place new tests under `test/` mirroring the source structure.
55+
- Use fixtures (`test/fixtures/`) for test data.
56+
- Mock external HTTP calls with WebMock.
57+
58+
## Development Setup
59+
60+
See [README.md](README.md) for full setup instructions.
61+
62+
## License
63+
64+
By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024-2026 Daisuke Adachi
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,14 @@ This starts up Overmind running the processes defined in `Procfile.dev`. We've c
9595

9696
## Contributing
9797

98-
If you have an improvement you'd like to share, create a fork of the repository and send us a pull request.
98+
Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on reporting issues, proposing changes, and submitting pull requests.
99+
100+
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
101+
102+
## Security
103+
104+
If you discover a security vulnerability, please follow the disclosure process in [SECURITY.md](SECURITY.md). Do not open public issues for security concerns.
105+
106+
## License
107+
108+
This project is licensed under the MIT License — see [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)