Skip to content
Permalink
Browse files

Merge pull request #5 from meituan/feature/addTemplates

feat(all) : add templates
  • Loading branch information...
ValiantCat committed Jul 10, 2018
2 parents f3ab0ab + 4b4e3c4 commit 94bcd12edc6578816324ee18383e7257c75241c0
@@ -0,0 +1,35 @@
<type>(<scope>) : <subject>

<body>


<footer>


#type value under below
# .feat :new feature
# .fix :fix some bug
# .refactor :refactor some code
# .perf :optimization performance
# .test :add more test case
#
#scope : describe effeter
# .all :Widely affected, should pay attention to this commit.
# .loation :little influence.

#
#subject: subject about this commit.
#
#body :detail describe about this commit.
#
#footer :associate issue id or other infomation.
#

# An Example

#
#feat(location) : <Description method>
#
# add description to EZRNode
#
# [Associate with issued id]
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. 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.
@@ -0,0 +1,30 @@
---
name: Issue template
about: Describe this issue template's purpose here.

---

<!--
Thanks for using EasyFoundation!
-->

### Context and Description

<!-- A description of the issue. -->

### Environment Details

* EasyFoundation version:
* iOS version:
* Xcode version:
* Other informations:

### Expected behavior

<!-- What do you think should happen? -->

### Actual behavior

<!-- What actually happens? -->

### Steps to Reproduce
@@ -0,0 +1,15 @@
### Summary

Provide a general description of the code changes in your pull
request... were there any bugs you had fixed? If so, mention them like 'fixes #x'. If
these bugs have open GitHub issues, be sure to tag them here as well,
to keep the conversation linked together.

### Other Information


If there's anything else that's important and relevant to your pull
request, mention that information here. This could include
benchmarks, or other information.

Thanks for contributing to EasyFoundation!
@@ -0,0 +1,47 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at it_easyreact@meituan.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project 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.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

@@ -0,0 +1,63 @@
# Contributing to EasyFoundation

We love contributions to the EasyFoundation project and request you follow the guidelines below. If you have any questions, or need any help, contact us on [EasyReact Team](mailto:it_easyreact@meituan.com).

## Table of Contents

<!-- TOC -->

- [Contributing to EasyFoundation](#contributing-to-easyfoundation)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Pull Requests](#pull-requests)
- [Asking Questions](#asking-questions)
- [Reporting Issues](#reporting-issues)
- [Additional Resources](#additional-resources)

<!-- /TOC -->

## Getting Started

To get started, you will need to open a Terminal and:

1. Fork this repo and clone it onto your machine.

`$ git clone https://github.com/YOUR_GITHUB_ID/EasyFoundation`

2. Make changes to code, usually by tackling an issue. A list of issues can be found [ISSUE](https://github.com/meituan/EasyFoundation/issues).

If there aren't any tagged issues, mail to [EasyReact Team](mailto:it_easyreact@meituan.com). and the team would be happy to help you get started.

3. Ensure all tests pass with your changes and test coverage must greater than before. If there is any new functionality introduced by your changes, new test case(s) may be required. If you need any help writing tests, contact us on [EasyReact Team](mailto:it_easyreact@meituan.com).

4. Commit message should conform to [commit message templates](./.github/COMMIT_MESSAGE_TEMPLATE.txt).

5. If the tests all pass, open a Pull Request following the guidelines below.

## Pull Requests

**Note:** Before opening a Pull Request, please run the tests and check they all pass and keep test coverage greater than or equal before.

EasyFoundation uses [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration). You may see mentions of [Travis CI](https://travis-ci.com/) in your PR and its comments. Travis is an external service we use that is automatically called on every PR, and runs the test cases on macOS and iPhone simulator to ensure every code change is stable.

To open a new Pull Request, the GitHub website provides the simplest experience for new users. Go to your fork of the repo and click the New pull request button. You will be presented with a page featuring base fork: and base:, then an arrow, and then head fork: compare:. Make sure compare: has **your branch** with your changes selected and base: has **master** selected. When you are ready to open the PR, click the green button at the top called Create pull request.

When opening a PR, please:

1. Create minimal differences and do not reformat the code. If you feel the codes structure needs changing, open a separate PR.
2. Check for unnecessary white space using `git diff --check` before you commit your code.

## Asking Questions

If you have any questions, mail to [EasyReact Team](mailto:it_easyreact@meituan.com). Comment on existing issues, or raise new ones if you discover something.

## Reporting Issues

See the [issue template](./.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md).

---

### Additional Resources

- [GitHub Help - Homepage](https://help.github.com)
- [Creating a Pull Request - GitHub Help](https://help.github.com/articles/creating-a-pull-request/)

0 comments on commit 94bcd12

Please sign in to comment.
You can’t perform that action at this time.