Skip to content

Commit 70819cb

Browse files
trongnhanuittrongnhanuit
authored
Merge pull request #31 from cbielow/feat_docs
add CONTRIBUTING, CODE_OF_CONDUCT and a license logo
2 parents ec6fdc8 + 2168584 commit 70819cb

File tree

3 files changed

+171
-4
lines changed

3 files changed

+171
-4
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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, 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
63+
mail[at-sign]bsc.fu-berlin.de.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
### Contributing - Get Involved!
2+
3+
We welcome input from our user base!
4+
`cmaple` is published under a **GPL v2.0** License (see [LICENSE](LICENSE) file), so feel free to fork, patch and contribute!
5+
6+
There are many ways to get involved, _you do not need to be a developer_!
7+
- suggest a new feature (and why you think it's useful) by opening [a new ticket][issuetracker] here on GitHub.
8+
- suggest changes to existing existing functionality (improvements or bugfixes), see above.
9+
- suggest improvements to our documentation
10+
- write code and submit a [Pull Request (PR)][PullRequest].
11+
12+
### Bug reporting / Feature requests
13+
14+
If you encounter a bug, e.g. unexpected results, long runtime, program failure etc, then please visit the [GitHub issue tracker][issuetracker] and file a report.
15+
16+
You should include all information to reproduce the problem:
17+
- **version of cmaple**
18+
- **input data**
19+
- **user parameters** / invocation
20+
- **error message / program output**
21+
22+
Please be as precise as possible when providing the bug report - just imagine what kind of information you would like to have in order
23+
to track down the issue.
24+
25+
[issuetracker]: https://github.com/iqtree/cmaple/issues
26+
[PullRequest]: https://github.com/iqtree/cmaple/pulls

‎README.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,37 @@
1-
# What's CMAPLE?
1+
# CMAPLE
2+
3+
[![License (GPL v2.0)](https://img.shields.io/badge/GPL%20v2.0-License?logo=gnu&label=License)](https://opensource.org/license/gpl-2-0)
4+
5+
6+
## What's CMAPLE?
27

38

49
CMAPLE is a C++ reimplementation of [MAPLE][MAPLE_FORMAT] - a novel likelihood-based phylogenetic inference method for pandemic-scale epidemiological genomic data. CMAPLE is highly optimized for performance and scalability with many new features.
510

611
Apart from a standalone software, we also provide a set of APIs, which allow users to integrate CMAPLE into existing phylogenetic inference methods. For more detail, please see <TBU>**API_Documentation**.
712

813

9-
# How to cite CMAPLE?
14+
## How to cite CMAPLE?
1015

1116
<TBU>To be updated...
1217

1318

14-
# How to use CMAPLE?
19+
## How to use CMAPLE?
1520

1621

1722
Please refer to our [Wiki page](https://github.com/iqtree/cmaple/wiki) for installation instructions and usage examples of CMAPLE.
1823

1924

25+
## Contributing - Get Involved!
26+
27+
See [CONTRIBUTING](CONTRIBUTING.md) file.
28+
29+
## Code of Conduct
30+
31+
CMaple is governed by some rules, which serve to protect our community and its individuals. See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
32+
2033

21-
# Acknowledgment
34+
## Acknowledgment
2235
CMAPLE relies on the following third-party libraries:
2336

2437
- **[ncl](https://github.com/mtholder/ncl)** (version 2.0) - Licensed under the [GNU General Public License](https://github.com/mtholder/ncl/blob/master/COPYING).

0 commit comments

Comments
 (0)