-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from yunji0387/Development
Add Contribution & License Note
- Loading branch information
Showing
2 changed files
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Contributing to Next Form Data Backend Server | ||
|
||
First off, thank you for considering contributing to the Next Form Data Backend Server. It's people like you that make it a great tool. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. | ||
|
||
- **Use a clear and descriptive title** for the issue to identify the problem. | ||
- **Provide a step-by-step description** of the suggested enhancement in as many details as possible. | ||
- **Provide specific examples** to demonstrate the steps. Include snippets of code or screenshots if you think they will help. | ||
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. | ||
- **Explain which behavior you expected to see instead and why.** | ||
|
||
### Suggesting Enhancements | ||
|
||
This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. | ||
|
||
- **Fill in the template**, including the steps that you imagine you would take if the feature you're requesting existed. | ||
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. | ||
- **Explain why this enhancement would be useful** to most Next Form Data Backend Server users. | ||
|
||
### Your First Code Contribution | ||
|
||
Unsure where to begin contributing to Football League Standings Backend Server? You can start by looking through 'beginner' and 'help-wanted' issues: | ||
|
||
- **Beginner issues** - issues that should only require a few lines of code, and a test or two. | ||
- **Help wanted issues** - issues that may need a bit more effort or knowledge about the project. | ||
|
||
### Pull Requests | ||
|
||
- **Fill in the required template** | ||
- **Do not include issue numbers in the PR title** | ||
- **Include screenshots and animated GIFs** in your pull request whenever possible. | ||
- **Follow the [Node.js coding style guide](https://github.com/airbnb/javascript)** | ||
- **Document new code** based on the project's code documentation style | ||
- **End all files with a newline** | ||
|
||
## Styleguides | ||
|
||
### Git Commit Messages | ||
|
||
- Use the present tense ("Add feature" not "Added feature") | ||
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") | ||
- Limit the first line to 72 characters or less | ||
- Reference issues and pull requests liberally after the first line | ||
|
||
### JavaScript Styleguide | ||
|
||
All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com/). | ||
|
||
## License | ||
|
||
By contributing to Next Form Data Backend Server, you agree that your contributions will be licensed under its MIT License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Yun Ji How | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |