Skip to content

Commit 4b9405c

Browse files
committed
Bump version and add changelog, code of conduct etc
1 parent db974e8 commit 4b9405c

5 files changed

Lines changed: 135 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [0.3.0] - 2021-06-25
8+
9+
### Added
10+
* Added CHANGELOG.md, CODE_OF_CONDUCT.md and CONTRIBUTING.md
11+
12+
### Changed
13+
* Upgrade to nanopub v1.2.7 (among other things, to fix click bug)

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ keywords:
2727
license: "Apache-2.0"
2828
message: "If you use this software, please cite it using these metadata."
2929
title: "fairworkflows: A python library for handling semantically described scientific workflows"
30-
version: "0.2.9"
30+
version: "0.3.0"

CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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 r.richardson@esciencecenter.nl. 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

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing guidelines
2+
3+
We welcome any kind of contribution to our software, from simple comment or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
4+
5+
A contribution can be one of the following cases:
6+
7+
1. you have a question;
8+
1. you think you may have found a bug (including unexpected behavior);
9+
1. you want to make some kind of change to the code base (e.g. to fix a bug, to add a new feature, to update documentation).
10+
11+
The sections below outline the steps in each case.
12+
13+
## You have a question
14+
15+
1. use the search functionality [here](https://github.com/fair-workflows/fairworkflows/issues) to see if someone already filed the same issue;
16+
1. if your issue search did not yield any relevant results, make a new issue;
17+
1. apply the "Question" label; apply other labels when relevant.
18+
19+
## You think you may have found a bug
20+
21+
1. use the search functionality [here](https://github.com/fair-workflows/fairworkflows/issues) to see if someone already filed the same issue;
22+
1. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
23+
- the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
24+
- some identifying information (name and version number) for dependencies you're using;
25+
- information about the operating system;
26+
1. apply relevant labels to the newly created issue.
27+
28+
## You want to make some kind of change to the code base
29+
30+
1. (**important**) announce your plan to the rest of the community _before you start working_. This announcement should be in the form of a (new) issue;
31+
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
32+
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
33+
1. install the dependencies required to run `fairworkflows` in development:
34+
35+
```bash
36+
pip install -r requirements.txt
37+
```
38+
39+
1. make sure the existing tests still work by running ``pytest``. Note that any pull requests to the fairworkflows repository on github will automatically trigger running of the test suite;
40+
1. check that the code is in accordance with the PEP8 style guide, by running ``flake8 . --count --show-source --statistics``,
41+
configuration is in `tox.ini`.
42+
1. add your own tests (if necessary);
43+
1. update or expand the documentation;
44+
1. [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the fairworkflows repository on GitHub;
45+
1. create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
46+
47+
In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.

fairworkflows/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.2.9"
1+
__version__ = "0.3.0"

0 commit comments

Comments
 (0)