Skip to content

Commit a54b315

Browse files
committed
add some guidelines
1 parent 65d00cb commit a54b315

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

.github/contributing.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
For features or bug fixes, please submit a pull request. Ideally there would be a test as well. The remainder of this doc details how to run the tests.
4+
5+
## Tests
6+
### Unit Tests
7+
- `rake test:unit` run on Travis automatically
8+
9+
### Functional Tests
10+
- iOS
11+
- `rake test:func:ios`
12+
- Android
13+
- `rake test:func:android`
14+
15+
## Publishing on rubygems
16+
17+
0. Ensure you have `~/.gem/credentials` If not run [the following command](http://guides.rubygems.org/make-your-own-gem/) (replace username with your rubygems user)
18+
> $ curl -u username https://rubygems.org/api/v1/api_key.yaml >
19+
~/.gem/credentials; chmod 0600 ~/.gem/credentials
20+
21+
1. Bump the version number `thor bump`
22+
2. Generate release note, build and publish gem with `thor release`
23+
3. Update `changelog.md`

.github/issue_template.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## This is a
2+
* [ ] Bug report
3+
* [ ] Question
4+
* [ ] Feature Request
5+
6+
## Summary
7+
8+
## Environment
9+
* `ruby_lib_core` version:
10+
* Mobile platform/version/device under test:
11+
12+
## Actual behaviour and steps to reproduce
13+
14+
## Expected behaviour
15+
16+
## Link to Appium/Ruby logs
17+
18+
Create a [GIST](https://gist.github.com) which is a paste of your _full_ Appium logs, and link them here.
19+
20+
## Any additional comments

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
33

44
## [Unreleased]
55
### Enhancements
6+
- Add guidelines in `.github`
67

78
### Bug fixes
89

0 commit comments

Comments
 (0)