Skip to content

Commit be412c8

Browse files
ana-kopana-kop
committed
Added license, code of conduct, contributing
1 parent 5cb55c2 commit be412c8

File tree

3 files changed

+174
-0
lines changed

3 files changed

+174
-0
lines changed

‎CODE_OF_CONDUCT.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# 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+
nationality, personal appearance, race, religion, or sexual identity and
10+
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 sexualised 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 [[email protected]](mailto:[email protected]). 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 [PurpleBooth's Template](https://gist.github.com/PurpleBooth/b24679402957c63ec426)
71+
which was adapted from [Contributor Covenant][homepage], version 1.4,
72+
available at [http://contributor-covenant.org/version/1/4][version].
73+
74+
[homepage]: http://contributor-covenant.org
75+
[version]: http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing
2+
3+
When it comes to planning in the built environment, we think transparency is critical. The shape and operations of our shared infrastructure and public spaces impacts individuals’ access to employment opportunities, education, social communities, clean air, and safe mobility options.
4+
We think open source, agent based models are the future for transparent, granular city planning. So we built GeNet which helps to make the process of modifying and validating MATSim transport networks a little less painful.
5+
6+
Thank you for considering contributing to GeNet! We're really excited to hear your opinions on the project and any ideas
7+
you may have on how it can be better!
8+
9+
Please note we have a code of conduct. Please follow it in all your interactions with the project.
10+
11+
## Ways to Contribute
12+
13+
There are a number of ways you can contribute to the project. The major two are:
14+
- Submitting a GitHub issue. This could involve:
15+
- Logging a bug or undesirable behaviour
16+
- Recording area of possible improvement
17+
- Requesting a change or addition of a new feature
18+
- Contributing code. Our work is never done, if you have an idea how you could make GeNet better or if you think you
19+
could generalise it:
20+
- You can outline the new feature or desired behaviour in a GitHub issue and send us an email on [[email protected]](mailto:[email protected])
21+
to let us know you're willing to work on it. We may invite you for a brief rubber-ducking session to go through
22+
your idea in more detail. The aim is to mature your idea with one (or more) GeNet developers and to flag
23+
any possible blocks or implementation issues to be aware of.
24+
- Please follow advice below on Contributing Code, working in a branch and the Pull Request process.
25+
- You may continue to, and are encouraged to, keep in touch and reach out to us throughout your development work.
26+
27+
See this helpful site on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) for more ideas
28+
on how you could contribute. Get in touch with us via email [[email protected]](mailto:[email protected]).
29+
30+
## Submitting Issues
31+
32+
If you have an idea for an enhancement, a change or addition of new feature or behaviour for GeNet or a record of a bug
33+
you can communicate this to us in detail through a written account as a GitHub issue on GeNet's [issues page](https://github.com/arup-group/genet/issues).
34+
35+
A good issue will outline the problem in a full written format. It is helpful to include screenshots, especially to
36+
highlight any physical issues with the network. It is also helpful to include why you think the new feature would be
37+
useful, what problem is it solving and whether there is a real-world cases study that would benefit from this
38+
improvement.
39+
40+
In case of bugs, please provide the full error message, the OS and
41+
information about the environment in which the process had been ran. It is also helpful to include a small
42+
(if possible) set of data on which the problem can be recreated---at the very least, a thorough description of the
43+
input data should be included.
44+
45+
See this page on [Creating an issue](https://github.com/arup-group/genet/issues) on GitHub to learn how to submit an
46+
issue.
47+
48+
## Contributing Code - Pull Request Process
49+
50+
1. All new work is done in a branch taken from master, details can be found here:
51+
[feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow)
52+
2. Ensure your work is covered by unit tests to the required percentage level. This script
53+
[`bash_scripts/code-coverage.sh`](https://github.com/arup-group/genet/blob/master/bash_scripts/code-coverage.sh)
54+
will help both in checking that the coverage level is satisfied and investigating places in code that have not been
55+
covered by the tests (via an output file `reports/coverage/index.html` which can be viewed in a browser).
56+
3. Ensure the sample notebooks execute without error by running `./bash_scripts/notebooks-smoke-test.sh`. Problems in
57+
the core GeNet APIs or in the notebooks themselves can both cause notebook failures.
58+
4. Provide [docstrings](https://www.python.org/dev/peps/pep-0257/) for new methods
59+
5. Perform linting locally using ```flake8 . --max-line-length 120 --count --show-source --statistics --exclude=scripts,tests```
60+
6. Add or update dependencies in `requirements.txt` if applicable
61+
7. Ensure the CI build pipeline (Actions tab in GitHub) completes successfully for your branch. The pipeline performs
62+
automated `PEP8` checks and runs unit tests in a fresh environment, as well as installation of all dependencies.
63+
8. Update/add to or generate a new jupyter notebook in `notebooks` directory which takes the user through your new feature or
64+
change. You may use example data already in `example_data` directory of this repo, or add more (small amount of) data to
65+
it to show off your new features.
66+
9. Add section in the `README.md` which shows usage of your new feature. This can be paraphrased from the jupyter
67+
notebook in point above.
68+
10. If the feature is to be used in an automated workflow through the docker image, create n example script in the
69+
`scripts` directory. Please use existing scripts as templates.
70+
11. Submit your Pull Request (see [GitHub Docs on Creating a Pull Request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)),
71+
describing the feature, linking to any relevant GitHub issues and request review from at
72+
least two developers. (Please take a look at latest commits to find out which developers you should request review from)
73+
12. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
74+
do not have permission to do that, please request one of the reviewers to merge it for you.
75+
76+
## Attribution
77+
78+
The Contribution Guide was adapted from [PurpleBooth's Template](https://gist.github.com/PurpleBooth/b24679402957c63ec426).

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Arup
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)