Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gevent
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
gevent
Commits
71212515
Commit
71212515
authored
Mar 16, 2016
by
Jason Madden
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add basic initial CONTRIBUTING.rst per github guidelines. Add badges for landscape.io.
[skip ci]
parent
5b81e524
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
69 additions
and
3 deletions
+69
-3
CONTRIBUTING.rst
CONTRIBUTING.rst
+48
-0
MANIFEST.in
MANIFEST.in
+1
-0
README.rst
README.rst
+13
-2
dev-requirements.txt
dev-requirements.txt
+4
-0
setup.py
setup.py
+3
-1
No files found.
CONTRIBUTING.rst
0 → 100644
View file @
71212515
Basics
======
Please see `contribution-guide.org <http://www.contribution-guide.org/>`_ for
general details on what we expect from contributors. Thanks!
gevent-specific details
=======================
There are a number of systems in place to help ensure gevent is of the
highest possible quality:
- Builds on Travis CI automatically submit updates to `coveralls.io`_ to
monitor test coverage. Pull requests that don't feature adequate test
coverage will be automatically failed.
.. image:: https://coveralls.io/repos/gevent/gevent/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/gevent/gevent?branch=master
- Likewise, builds on Travis CI will automatically submit updates to
`landscape.io`_ to monitor code health (adherence to PEP8, absence of
common code smells, etc). Pull requests that decrease code health will
be automatically failed.
.. image:: https://landscape.io/github/gevent/gevent/master/landscape.svg?style=flat
:target: https://landscape.io/github/gevent/gevent/master
:alt: Code Health
- A test suite is run for every push and pull request submitted. Travis
CI is used to test on Linux, and `AppVeyor`_ runs the builds on
Windows. Pull requests with tests that don't pass will be
automatically failed.
.. image:: https://travis-ci.org/gevent/gevent.svg?branch=master
:target: https://travis-ci.org/gevent/gevent
.. image:: https://ci.appveyor.com/api/projects/status/q4kl21ng2yo2ixur?svg=true
:target: https://ci.appveyor.com/project/denik/gevent
.. _landscape.io: https://landscape.io/github/gevent/gevent
.. _coveralls.io: https://coveralls.io/github/gevent/gevent
.. _AppVeyor: https://ci.appveyor.com/project/denik/gevent
Pull requests that don't pass those checks will be automatically
failed. But don't worry, it's all about context. Most of the time
failing checks are easy to fix, and occasionally a PR will be accepted
even with failing checks to be fixed by the maintainers.
MANIFEST.in
View file @
71212515
...
...
@@ -9,6 +9,7 @@ recursive-include util *
include LICENSE
include NOTICE
include README.rst
include CONTRIBUTING.rst
include TODO
include changelog.rst
include MANIFEST.in
...
...
README.rst
View file @
71212515
...
...
@@ -99,16 +99,26 @@ something like this::
coverage html -i
<open htmlcov/index.html>
Builds on Travis CI automatically submit updates to `coveralls.io`_.
Builds on Travis CI automatically submit updates to `coveralls.io`_ to
monitor test coverage.
.. image:: https://coveralls.io/repos/gevent/gevent/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/gevent/gevent?branch=master
Likewise, builds on Travis CI will automatically submit updates to
`landscape.io`_ to monitor code health (adherence to PEP8, absence of
common code smells, etc).
.. image:: https://landscape.io/github/gevent/gevent/master/landscape.svg?style=flat
:target: https://landscape.io/github/gevent/gevent/master
:alt: Code Health
Continuous integration
----------------------
A test suite is run for every push and pull request submitted. Travis
CI is used to test on Linux, and `AppVeyor`_ runs the builds on Windows.
CI is used to test on Linux, and `AppVeyor`_ runs the builds on
Windows.
.. image:: https://travis-ci.org/gevent/gevent.svg?branch=master
:target: https://travis-ci.org/gevent/gevent
...
...
@@ -134,3 +144,4 @@ CI is used to test on Linux, and `AppVeyor`_ runs the builds on Windows.
.. _AppVeyor: https://ci.appveyor.com/project/denik/gevent
.. _what's new: http://www.gevent.org/whatsnew_1_1.html
.. _changelog: http://www.gevent.org/changelog.html
.. _landscape.io: https://landscape.io/github/gevent/gevent
dev-requirements.txt
View file @
71212515
...
...
@@ -6,4 +6,8 @@ prospector[with_pyroma]
coverage
>=4.0
coveralls
>=1.0
cffi
# For viewing README.rst (restview --long-description),
# CONTRIBUTING.rst, etc.
# https://github.com/mgedmin/restview
restview
-e .
setup.py
View file @
71212515
...
...
@@ -405,6 +405,7 @@ else:
# If we are running info / help commands, or we're being imported by
# tools like pyroma, we don't need to build anything
_BUILDING
=
True
if
((
len
(
sys
.
argv
)
>=
2
and
(
'--help'
in
sys
.
argv
[
1
:]
or
sys
.
argv
[
1
]
in
(
'--help-commands'
,
...
...
@@ -413,6 +414,7 @@ if ((len(sys.argv) >= 2
'clean'
,
'--long-description'
)))
or
__name__
!=
'__main__'
):
_BUILDING
=
False
ext_modules
=
[]
include_package_data
=
PYPY
run_make
=
False
...
...
@@ -531,5 +533,5 @@ except BuildFailed:
raise
ext_modules
.
remove
(
ARES
)
run_setup
(
ext_modules
,
run_make
=
run_make
)
if
ARES
not
in
ext_modules
and
__name__
==
'__main__'
:
if
ARES
not
in
ext_modules
and
__name__
==
'__main__'
and
_BUILDING
:
sys
.
stderr
.
write
(
'
\
n
WARNING: The gevent.ares extension has been disabled.
\
n
'
)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment