Skip to content

Commit af378dd

Browse files
committed
docs: add guide
1 parent 500201c commit af378dd

12 files changed

+187
-115
lines changed

CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Contributing to TOAST UI
2+
3+
First off, thanks for taking the time to contribute! 🎉 😘 ✨
4+
5+
The following is a set of guidelines for contributing to TOAST UI. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
## Reporting Bugs
8+
Bugs are tracked as GitHub issues. Search the list and try to reproduce on [demo](https://nhn.github.io/tui.calendar/latest/tutorial-example00-basic) before you create an issue. When you create an issue, please provide the following information by filling in the template.
9+
10+
Explain the problem and include additional details to help maintainers reproduce the problem:
11+
12+
* **Use a clear and descriptive title** for the issue to identify the problem.
13+
* **Describe the exact steps which reproduce the problem** in as many details as possible. Don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used a mouse or a keyboard.
14+
* **Provide specific examples to demonstrate the steps.** Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets on the issue, use Markdown code blocks.
15+
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
16+
* **Explain which behavior you expected to see instead and why.**
17+
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
18+
19+
## Suggesting Enhancements
20+
In case you want to suggest for TOAST UI Calendar, please follow this guideline to help maintainers and the community understand your suggestion.
21+
Before creating suggestions, please check [issue list](https://github.com/nhn/tui.calendar/labels/Type:%20Enhancement) if there's already a request.
22+
23+
Create an issue and provide the following information:
24+
25+
* **Use a clear and descriptive title** for the issue to identify the suggestion.
26+
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
27+
* **Provide specific examples to demonstrate the steps.** Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
28+
* **Include screenshots and animated GIFs** which helps demonstrate the steps or point out the part of TOAST UI Calendar which the suggestion is related to.
29+
* **Explain why this enhancement would be useful** to most TOAST UI users.
30+
* **List some other applications where this enhancement exists.**
31+
32+
## First Code Contribution
33+
34+
Unsure where to begin contributing to TOAST UI? You can start by looking through these `document`, `good first issue` and `help wanted` issues:
35+
36+
* **document issues**: issues which should be reviewed or improved.
37+
* **good first issues**: issues which should only require a few lines of code, and a test or two.
38+
* **help wanted issues**: issues which should be a bit more involved than beginner issues.
39+
40+
## Pull Requests
41+
42+
### Development WorkFlow
43+
- Set up your development environment
44+
- Make change from a right branch
45+
- Be sure the code passes `npm run eslint`, `npm run test`
46+
- Make a pull request
47+
48+
### Development environment
49+
- Prepare your machine node and it's packages installed.
50+
- Checkout our repository
51+
- Install dependencies by `npm install`
52+
- Start webpack-dev-server by `npm run serve`
53+
54+
### Make changes
55+
#### Checkout a branch
56+
* **master**: PR base branch. merge features, updates for next minor or major release.
57+
lastest release branch with distribution files.
58+
- **gh-pages**: API docs, examples and demo
59+
60+
#### Check Code Style
61+
Run `npm run eslint` and make sure all the tests pass.
62+
63+
#### Test
64+
Run `npm run test` and verify all the tests pass.
65+
If you are adding new commands or features, they must include tests.
66+
If you are changing functionality, update the tests if you need to.
67+
68+
#### Commit
69+
Follow our [commit message conventions](./docs/COMMIT_MESSAGE_CONVENTION.md).
70+
71+
### Yes! Pull request
72+
Make your pull request, then describe your changes.
73+
#### Title
74+
Follow other PR title format on below.
75+
```
76+
<Type>: Short Description (fix #111)
77+
<Type>: Short Description (fix #123, #111, #122)
78+
<Type>: Short Description (ref #111)
79+
```
80+
* capitalize first letter of Type
81+
* use present tense: 'change' not 'changed' or 'changes'
82+
83+
#### Description
84+
If it has related to issues, add links to the issues(like `#123`) in the description.
85+
Fill in the [Pull Request Template](./docs/PULL_REQUEST_TEMPLATE.md) by check your case.
86+
87+
## Code of Conduct
88+
This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
89+
90+
> This Guide is base on [atom contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md), [CocoaPods](http://guides.cocoapods.org/contributing/contribute-to-cocoapods.html) and [ESLint](http://eslint.org/docs/developer-guide/contributing/pull-requests)
91+
92+
[demo]:https://nhn.github.io/tui.calendar/

LICENSE

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

apps/react-calendar/docs/ISSUE_TEMPLATE.md

-25
This file was deleted.

apps/vue-calendar/docs/COMMIT_MESSAGE_CONVENTION.md

-49
This file was deleted.

apps/vue-calendar/docs/PULL_REQUEST_TEMPLATE.md

-41
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)