Skip to content

Commit 0cbfedb

Browse files
alvarolopezalvarolopez
committed
Add community and informative files
1 parent dbef77e commit 0cbfedb

File tree

4 files changed

+300
-0
lines changed

4 files changed

+300
-0
lines changed

‎.github/ISSUE_TEMPLATE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
### Description
2+
3+
[Description of the bug or feature]
4+
5+
### Steps to Reproduce
6+
7+
1. [First Step]
8+
2. [Second Step]
9+
3. [and so on...]
10+
11+
### Expected behavior:
12+
13+
[What you expected to happen]
14+
15+
### Actual behavior
16+
17+
[What actually happened]
18+
19+
### Versions
20+
21+
You can get this information from executing `caso --version`.

‎.github/PULL_REQUEST_TEMPLATE.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also
4+
include relevant motivation and context. List any dependencies that are
5+
required for this change. Please note that there may be some sections that may
6+
not apply to your change, in that case feel free to delete them.
7+
8+
Fixes # (issue)
9+
10+
## Type of change
11+
12+
Please delete options that are not relevant.
13+
14+
- [ ] Bug fix (non-breaking change which fixes an issue)
15+
- [ ] New feature (non-breaking change which adds functionality)
16+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
17+
- [ ] This change requires a documentation update
18+
- [ ] This change is a documentation update
19+
20+
# How Has This Been Tested?
21+
22+
Please describe the tests that you ran to verify your changes. Provide
23+
instructions so we can reproduce. Please also list any relevant details for
24+
your test configuration
25+
26+
- [ ] Test A
27+
- [ ] Test B
28+
29+
# Checklist:
30+
31+
- [ ] My code follows the style guidelines of this project
32+
- [ ] I have performed a self-review of my own code
33+
- [ ] I have commented my code, particularly in hard-to-understand areas
34+
- [ ] I have made corresponding changes to the documentation
35+
- [ ] My changes generate no new warnings
36+
- [ ] I have added tests that prove my fix is effective or that my feature works
37+
- [ ] New and existing unit tests pass locally with my changes

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

+168
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
# Contributing
2+
3+
Contributions are welcome, and they are greatly appreciated! Every
4+
little bit helps, and credit will always be given.
5+
6+
## Types of Contributions
7+
8+
You can contribute in many ways:
9+
10+
### Report Bugs
11+
12+
Report bugs at https://github.com/IFCA/deepaas/issues.
13+
14+
If you are reporting a bug, please include:
15+
16+
* Your operating system name and version.
17+
* Any details about your local setup that might be helpful in troubleshooting.
18+
* If you can, provide detailed steps to reproduce the bug.
19+
* If you don't have steps to reproduce the bug, just note your observations in
20+
as much detail as you can. Questions to start a discussion about the issue
21+
are welcome.
22+
23+
### Fix Bugs
24+
25+
Look through the GitHub issues for bugs. Anything tagged with "bug"
26+
is open to whoever wants to implement it.
27+
28+
### Implement Features
29+
30+
Look through the GitHub issues for features. Anything tagged with "enhancement"
31+
and "please-help" is open to whoever wants to implement it.
32+
33+
Please do not combine multiple feature enhancements into a single pull request.
34+
35+
Note: this project is very conservative, so new features that aren't tagged
36+
with "please-help" might not get into core. We're trying to keep the code base
37+
small, extensible, and streamlined. Whenever possible, it's best to try and
38+
implement feature ideas as separate projects outside of the core codebase.
39+
40+
### Write Documentation
41+
42+
cASO could always use more documentation, whether as part of the official cASO
43+
docs, in docstrings, or even on the web in blog posts, articles, and such.
44+
45+
If you want to review your changes on the documentation locally, you can do::
46+
47+
pip install -r docs/requirements.txt
48+
make servedocs
49+
50+
This will compile the documentation, open it in your browser and start
51+
watching the files for changes, recompiling as you save.
52+
53+
### Submit Feedback
54+
55+
The best way to send feedback is to file an issue at the follwing URL:
56+
57+
https://github.com/IFCA/deepaas/issues
58+
59+
If you are proposing a feature:
60+
61+
* Explain in detail how it would work.
62+
* Keep the scope as narrow as possible, to make it easier to implement.
63+
* Remember that this is a volunteer-driven project, and that contributions
64+
are welcome :)
65+
66+
## Setting Up the Code for Local Development
67+
68+
Here's how to set up `deepaas` for local development.
69+
70+
1. Fork the `deepaas` repo on GitHub.
71+
2. Clone your fork locally::
72+
73+
$ git clone [email protected]:your_name_here/deepaas.git
74+
75+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
76+
77+
$ mkvirtualenv deepaas
78+
$ cd deepaas/
79+
$ python setup.py develop
80+
81+
4. Create a branch for local development::
82+
83+
$ git checkout -b name-of-your-bugfix-or-feature
84+
85+
Now you can make your changes locally.
86+
87+
5. When you're done making changes, check that your changes pass the tests and
88+
the style checks (pep8, flake8 and
89+
https://docs.openstack.org/hacking/latest/):
90+
91+
$ pip install tox
92+
$ tox
93+
94+
Please note that tox runs the style tests automatically, since we have a test
95+
environment for it (named pep8).
96+
97+
If you feel like running only the pep8 environment, please use the following
98+
command::
99+
100+
$ tox -e pep8
101+
102+
6. Commit your changes and push your branch to GitHub::
103+
104+
$ git add .
105+
$ git commit -m "Your detailed description of your changes."
106+
$ git push origin name-of-your-bugfix-or-feature
107+
108+
7. Check that the test coverage hasn't dropped::
109+
110+
$ tox -e cover
111+
112+
8. Submit a pull request through the GitHub website.
113+
114+
115+
## Contributor Guidelines
116+
117+
### Pull Request Guidelines
118+
119+
Before you submit a pull request, check that it meets these guidelines:
120+
121+
1. The pull request should include tests.
122+
2. If the pull request adds functionality, the docs should be updated. Put
123+
your new functionality into a function with a docstring, and add the
124+
feature to the list in README.rst.
125+
3. The pull request should work for Python 2.7, 3.4, 3.6 on Travis CI.
126+
4. Check https://travis-ci.org/IFCA/deepaas/pull_requests to ensure the tests pass
127+
for all supported Python versions and platforms.
128+
129+
### Coding Standards
130+
131+
* PEP8
132+
* We follow the OpenStack Style Guidelines: https://docs.openstack.org/hacking/latest/user/hacking.html#styleguide
133+
* Write new code in Python 3.
134+
135+
## Testing with tox
136+
137+
Tox uses `py.test` under the hood, hence it supports the same syntax for selecting tests.
138+
139+
For further information please consult the `pytest usage docs`_.
140+
141+
To run a particular test class with tox::
142+
143+
$ tox -e py '-k TestCasoManager'
144+
145+
To run some tests with names matching a string expression::
146+
147+
$ tox -e py '-k generate'
148+
149+
Will run all tests matching "generate", test_generate_files for example.
150+
151+
To run just one method::
152+
153+
$ tox -e py '-k "TestCasoManager and test_required_fields"'
154+
155+
To run all tests using various versions of python in virtualenvs defined in tox.ini, just run tox.::
156+
157+
$ tox
158+
159+
This configuration file setup the pytest-cov plugin and it is an additional
160+
dependency. It generate a coverage report after the tests.
161+
162+
It is possible to tests with some versions of python, to do this the command
163+
is:
164+
165+
$ tox -e py27,py34
166+
167+
Will run py.test with the python2.7, python3.4 and pypy interpreters, for
168+
example.

0 commit comments

Comments
 (0)