Skip to content

Commit 43f83cd

Browse files
committed
changed readme and contributing markdowns with respect to joss guidelines, added code o conduct for the same reason
1 parent b688e28 commit 43f83cd

File tree

3 files changed

+168
-3
lines changed

3 files changed

+168
-3
lines changed

CODE_OF_CONDUCT.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at [email protected].
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
125+
at [https://www.contributor-covenant.org/translations][translations].
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
129+
[Mozilla CoC]: https://github.com/mozilla/diversity
130+
[FAQ]: https://www.contributor-covenant.org/faq
131+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

+28-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,27 @@
22

33
## Bug reports and feature requests
44

5-
In case you have questions, possible bugs or feature requests, please open an issue on Github.
5+
In case you have questions, possible bugs or feature requests, please, open an [issue](https://github.com/fabian-sp/GGLasso/issues) on Github.
6+
7+
Pull requests will be evaluated against a checklist:
8+
9+
1. __Motivation__. Your pull request should clearly and concisely motivate the need for change. Please, describe the problem your PR addresses and show how your pull request solves it as concisely as possible.
10+
11+
Also, include this motivation in `NEWS` so that when a new release of
12+
`gglasso` comes out it is easy for users to see what has changed. Add your
13+
item at the top of the file and use markdown for formatting. The
14+
news item should end with `(@yourGithubUsername, #the_issue_number)`.
15+
16+
2. __Only related changes__. Before you submit your pull request, please, check to make sure that you have NOT accidentally included any unrelated changes. These make it harder to see exactly what was changed, and to evaluate any unexpected side effects.
17+
18+
Each PR corresponds to a git branch, so if you expect to submit multiple changes
19+
make sure to create multiple branches. If you have multiple changes that depend
20+
on each other, start with the first one and do not submit any others until the
21+
first one has been processed.
22+
23+
3. __Use `gglasso` coding style__. We tried to adhere as closely as possible to the [PEP8](https://www.python.org/dev/peps/pep-0008/) guidelines, please, do so as well. Maintaining a consistent style across the whole code base makes it much easier to jump into the code. If you are modifying existing `gglasso` code that does not follow the style guide, a separate pull request to fix the style would be greatly appreciated.
24+
25+
4. If you add new parameters or a new function, you will also need to document them.
626

727
## Contributing code
828

@@ -14,6 +34,11 @@ The procedure for contributing code is the following:
1434
4. Run `pytest gglasso/tests` to see whether all tests are successfull. If you add new functionalities, add unit tests for these.
1535
5. Open a pull request for your feature branch on Github.
1636

17-
Also have a look at [this guide on forking in Github](https://guides.github.com/activities/forking/).
37+
Also, have a look at [this guide on forking in Github](https://guides.github.com/activities/forking/).
38+
39+
Useful information on how to write bug reports and the principles of contributing to open-source code projects are described on [the scikit-learn webpage](https://scikit-learn.org/stable/developers/contributing.html).
40+
41+
42+
## Fixing typos
43+
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file.
1844

19-
Useful information on how to write bug reports and the principles of contributing to open-source code projects are described on [the scikit-learn webpage](https://scikit-learn.org/stable/developers/contributing.html).

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ We implement the PPDNA Algorithm like proposed in [4]. To use this, import `warm
6161
4) ADMM method for Group Graphical Lasso where the features/variables are non-conforming<br>
6262
Method for problems where not all variables exist in all instances/datasets. To use this, import `ext_ADMM_MGL` from `gglasso/solver/ext_admm_solver`.<br>
6363

64+
## Community Guidelines
65+
66+
1) Contributions and suggestions to the software are always welcome.
67+
Please, consult our [contribution guidelines](CONTRIBUTING.md) prior
68+
to submitting a pull request.
69+
2) Report issues or problems with the software using github’s [issue
70+
tracker](https://github.com/fabian-sp/GGLasso/issues).
71+
3) Contributors must adhere to the [Code of
72+
Conduct](CODE_OF_CONDUCT.md).
6473

6574

6675
## References

0 commit comments

Comments
 (0)