Skip to content

Commit d381377

Browse files
grohonggrohong
authored
Merge pull request #9 from TileImageTeamiOS/develop
Develop
2 parents 8680d3a + e44ba3b commit d381377

File tree

4 files changed

+150
-0
lines changed

4 files changed

+150
-0
lines changed

‎CONTRIBUTING.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Contributing Guidelines
2+
3+
### Code of Conduct
4+
5+
6+
Please read our [Code of Conduct](https://github.com/TileImageTeamiOS/THScrollView-minimap/blob/master/Code_of_Conduct.md).
7+
The THScrollView-minimap maintainers take this Code of Conduct very seriously. Intolerance, disrespect, harassment, and any form of negativity will not be tolerated.
8+
9+
### Ways to Contribute
10+
11+
You can contribute to THScrollView-minimap in a variety of ways:
12+
13+
- Fixing or reporting bugs :scream:
14+
- Improving documentation :heart:
15+
- Suggesting new features :smiley:
16+
- Increasing unit test coverage :pray:
17+
- Resolving any open issues :+1:
18+
19+
20+
**Your contributions are always welcome, no contribution is too small.**
21+
22+
### Opening a New Issue
23+
24+
- Please check the [README](https://github.com/TileImageTeamiOS/THScrollView-minimap/blob/master/README.md) to see if your question is answered there.
25+
- Search [open issues](https://github.com/TileImageTeamiOS/THScrollView-minimap/issues?q=is%3Aopen+is%3Aissue) and [closed issues](https://github.com/TileImageTeamiOS/THScrollView-minimap/issues?q=is%3Aissue+is%3Aclosed) to avoid opening a duplicate issue.
26+
- Avoiding duplicate issues organizes all relevant information for project maintainers and other users.
27+
- If no issues represent your problem, please open a new issue with a good title and useful description.
28+
29+
- Information to Provide When Opening an Issue:
30+
- THScrollView-minimap version(s)
31+
- iOS version(s)
32+
- Devices/Simulators affected
33+
- Full crash log, if applicable
34+
- A well written description of the problem you are experiencing
35+
- *Please provide complete steps to reproduce the issue*
36+
- For UI related issues, please provide a screenshot/GIF/video showing the issue
37+
- Link to a project or demo project that exhibits the issue
38+
- Search for a list any issues that might be related
39+
40+
The more information you can provide, the easier it will be for us to resolve your issue in a timely manner.
41+
42+
### Submitting a Pull Request
43+
44+
- We strongly encourage you to open an issue discussing any potential new features before an implementation is provided.
45+
- This ensures the feature is in scope and no ones time is wasted.
46+
47+
- **Please DO NOT submit pull requests to the `master` branch**
48+
- This branch is always stable and represents a release.
49+
50+
- **Please DO submit your pull request to the branch representing the next release version**
51+
52+
1. Link to any issues the pull request resolves. If none exist, create one.
53+
2. Write unit tests for new functionality or fix any broken by your changes.
54+
3. If your changes affect documentation, please update them accordingly.
55+
4. Avoid pull requests with a large number of commits.
56+
5. Write clean code and follow the THScrollView-minimap [style guidelines](#style-guidelines).
57+
58+
**You should submit one pull request per feature, the smaller the pull request the better chances it will be merged.**
59+
Enormous pull requests take a significant time to review and understand their implications on the existing codebase.
60+
61+
### Style Guidelines
62+
63+
Writing clean code and upholding project standards is as important as adding new features. To ensure this, THScrollView-minimap employs a few practices:
64+
65+
1. We use [SwiftLint](https://github.com/realm/SwiftLint) to enforce style and conventions at compile time.
66+
2. We adhere to the [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/).

‎Contributor Code of Conduct.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of
4+
fostering an open and welcoming community, we pledge to respect all people who
5+
contribute through reporting issues, posting feature requests, updating
6+
documentation, submitting pull requests or patches, and other activities.
7+
8+
We are committed to making participation in this project a harassment-free
9+
experience for everyone, regardless of level of experience, gender, gender
10+
identity and expression, sexual orientation, disability, personal appearance,
11+
body size, race, ethnicity, age, religion, or nationality.
12+
13+
Examples of unacceptable behavior by participants include:
14+
15+
* The use of sexualized language or imagery
16+
* Personal attacks
17+
* Trolling or insulting/derogatory comments
18+
* Public or private harassment
19+
* Publishing other's private information, such as physical or electronic
20+
addresses, without explicit permission
21+
* Other unethical or unprofessional conduct
22+
23+
Project maintainers have the right and responsibility to remove, edit, or
24+
reject comments, commits, code, wiki edits, issues, and other contributions
25+
that are not aligned to this Code of Conduct, or to ban temporarily or
26+
permanently any contributor for other behaviors that they deem inappropriate,
27+
threatening, offensive, or harmful.
28+
29+
By adopting this Code of Conduct, project maintainers commit themselves to
30+
fairly and consistently applying these principles to every aspect of managing
31+
this project. Project maintainers who do not follow or enforce the Code of
32+
Conduct may be permanently removed from the project team.
33+
34+
This code of conduct applies both within project spaces and in public spaces
35+
when an individual is representing the project or its community.
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
38+
reported by contacting a project maintainer at [[email protected]](mailto:[email protected]). All
39+
complaints will be reviewed and investigated and will result in a response that
40+
is deemed necessary and appropriate to the circumstances. Maintainers are
41+
obligated to maintain confidentiality with regard to the reporter of an
42+
incident.
43+
44+
45+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
46+
version 1.3.0, available at
47+
[http://contributor-covenant.org/version/1/3/0/][version]
48+
49+
[homepage]: http://contributor-covenant.org
50+
[version]: http://contributor-covenant.org/version/1/3/0/

‎ISSUE_TEMPLATE.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
### Prerequisites
2+
3+
* [ ] Can you reproduce the problem in safe mode?
4+
* [ ] Are you running the latest version?
5+
* [ ] Did you check our CONTRIBUTING.md?
6+
* [ ] Are you reporting to the correct repository?
7+
* [ ] Did you perform a cursory search?
8+
9+
For more information, see the `CONTRIBUTING` guide.
10+
11+
### Description
12+
13+
[Description of the bug or feature]
14+
15+
### Steps to Reproduce
16+
17+
1. [First Step]
18+
2. [Second Step]
19+
3. [and so on...]
20+
21+
**Expected behavior:** [What you expected to happen]
22+
23+
**Actual behavior:** [What actually happened]

‎PULL_REQUEST_TEMPLATE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Types of changes
2+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
3+
- [ ] Bug fix (non-breaking change which fixes an issue)
4+
- [ ] New feature (non-breaking change which adds functionality)
5+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
6+
- [ ] I have read the **CONTRIBUTING** document.
7+
- [ ] My code follows the code style of this project.
8+
- [ ] My change requires a change to the documentation.
9+
- [ ] I have updated the documentation accordingly.
10+
- [ ] I have added tests to cover my changes.
11+
- [ ] All new and existing tests passed.

0 commit comments

Comments
 (0)