Skip to content

Commit f890546

Browse files
fix(travis): review build step requirements and docs
1 parent 3f60010 commit f890546

8 files changed

+104
-3
lines changed

.travis.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,14 @@ before_install:
1919
- npm prune
2020
install:
2121
- npm i
22+
- pip install -r requirements.txt
2223
before_script:
2324
- npm run lint
2425
script:
2526
- npm run test
27+
- "./scripts/pep8check.sh"
2628
after_success:
2729
- if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" ]]; then
28-
npx travis-deploy-once "npx semantic-release" ; fi
30+
git config --replace-all remote.origin.fetch +refs/heads/*:refs/remotes/origin/*
31+
&& git fetch --tags
32+
&& npx travis-deploy-once "npx semantic-release" ; fi

AUTHORS.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
> ⚠ This document _only_ reflects the responsible developers at HEXONET GmbH. For a list of MUCH-APPRECIATED CONTRIBUTORS -- people who helped developing and extending this library, applying patches, adding helpful comments
2+
and thus generally made it that much better, see [GitHub's list of contributors](https://github.com/hexonet/python-sdk/contributors).
3+
4+
* [Kai Schwarz](//github.com/papakai) - Full Review

CONTRIBUTING.md

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

LICENSE.txt LICENSE

File renamed without changes.

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"test-MOCHA": "./node_modules/.bin/_mocha $(find ./test -type f -name '*.spec.js')",
4444
"test-COVERAGE": "cross-env NODE_ENV=development nyc npm run test-MOCHA --silent",
4545
"lint": "eslint --fix --config=./.eslintrc.js uts46.js README.md *.json test/*.spec.js && npm run lint-python",
46-
"lint-python": "autopep8 -i -a -a *.py",
46+
"lint-python": "./scripts/pep8fix.sh",
4747
"semantic-release": "semantic-release"
4848
},
4949
"dependencies": {
@@ -103,4 +103,4 @@
103103
"@semantic-release/github"
104104
]
105105
}
106-
}
106+
}

requirements.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
autopep8==1.4.4
2+
pep8==1.7.1
3+
pip==19.0.3
4+
pycodestyle==2.5.0

scripts/pep8check.sh

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/bin/bash
2+
pycodestyle --first --show-source --show-pep8 setup.py hexonet/apiconnector/*.py tests/*.py

scripts/pep8fix.sh

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/bin/bash
2+
autopep8 -i -a -a ./*.py

0 commit comments

Comments
 (0)