Skip to content

Commit 2298155

Browse files
author
Ben J. Ward
authored
Contributing files rollout (#15)
* Rollout file CONTRIBUTING.md * Rollout file CODE_OF_CONDUCT.md * Rollout file .github/PULL_REQUEST_TEMPLATE.md * Rollout file .github/ISSUE_TEMPLATE.md
1 parent 27ef060 commit 2298155

File tree

4 files changed

+937
-0
lines changed

4 files changed

+937
-0
lines changed

‎.github/ISSUE_TEMPLATE.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
3+
> _This template is rather extensive. Fill out all that you can, if are a new contributor or you're unsure about any section, leave it unchanged and a reviewer will help you_ :smile:. _This template is simply a tool to help everyone remember the BioJulia guidelines, if you feel anything in this template is not relevant, simply delete it._
4+
5+
## Expected Behavior
6+
<!--- If you're describing a bug, tell us what you expect to happen -->
7+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
8+
9+
## Current Behavior
10+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
11+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
12+
13+
## Possible Solution / Implementation
14+
<!--- If describing a bug, suggest a fix/reason for the bug (optional) -->
15+
<!--- If you're suggesting a change/improvement, suggest ideas how to implement the addition or change -->
16+
17+
## Steps to Reproduce (for bugs)
18+
<!--- You may include copy/pasteable snippets or a list of steps to reproduce the bug -->
19+
1.
20+
2.
21+
3.
22+
4.
23+
24+
<!--- Optionally, provide a link to a live example -->
25+
<!--- You can use [this tool](https://www.cockos.com/licecap/) -->
26+
<!--- ...Or [this tool](https://github.com/colinkeenan/silentcast) -->
27+
<!--- ...Or [this tool](https://github.com/GNOME/byzanz) on Linux -->
28+
29+
## Context
30+
<!--- How has this issue affected you? What are you trying to accomplish? -->
31+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
32+
33+
## Your Environment
34+
<!--- Include as many relevant details about the environment you experienced the bug in -->
35+
- Package Version used:
36+
- Julia Version used:
37+
- Operating System and version (desktop or mobile):
38+
- Link to your project:
39+
40+
<!-- Can you list installed packages here? -->

‎.github/PULL_REQUEST_TEMPLATE.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# A clear and descriptive title (No issue numbers please)
2+
3+
> _This template is rather extensive. Fill out all that you can, if are a new contributor or you're unsure about any section, leave it unchanged and a reviewer will help you_ :smile:. _This template is simply a tool to help everyone remember the BioJulia guidelines, if you feel anything in this template is not relevant, simply delete it._
4+
5+
## Types of changes
6+
7+
This PR implements the following changes:
8+
_(Please tick any or all of the following that are applicable)_
9+
10+
* [ ] :sparkles: New feature (A non-breaking change which adds functionality).
11+
* [ ] :bug: Bug fix (A non-breaking change, which fixes an issue).
12+
* [ ] :boom: Breaking change (fix or feature that would cause existing functionality to change).
13+
14+
## :clipboard: Additional detail
15+
16+
- If you have implemented new features or behaviour
17+
- **Provide a description of the addition** in as many details as possible.
18+
19+
- **Provide justification of the addition**.
20+
21+
- **Provide a runnable example of use of your addition**. This lets reviewers
22+
and others try out the feature before it is merged or makes it's way to release.
23+
24+
- If you have changed current behaviour...
25+
- **Describe the behaviour prior to you changes**
26+
27+
- **Describe the behaviour after your changes** and justify why you have made the changes,
28+
Please describe any breakages you anticipate as a result of these changes.
29+
30+
- **Does your change alter APIs or existing exposed methods/types?**
31+
If so, this may cause dependency issues and breakages, so the maintainer
32+
will need to consider this when versioning the next release.
33+
34+
- If you are implementing changes that are intended to increase performance, you
35+
should provide the results of a simple performance benchmark exercise
36+
demonstrating the improvement. Especially if the changes make code less legible.
37+
38+
## :ballot_box_with_check: Checklist
39+
40+
- [ ] :art: The changes implemented is consistent with the [julia style guide](https://docs.julialang.org/en/stable/manual/style-guide/).
41+
- [ ] :blue_book: I have updated and added relevant docstrings, in a manner consistent with the [documentation styleguide](https://docs.julialang.org/en/stable/manual/documentation/).
42+
- [ ] :blue_book: I have added or updated relevant user and developer manuals/documentation in `docs/src/`.
43+
- [ ] :ok: There are unit tests that cover the code changes I have made.
44+
- [ ] :ok: The unit tests cover my code changes AND they pass.
45+
- [ ] :pencil: I have added an entry to the `[UNRELEASED]` section of the manually curated `CHANGELOG.md` file for this repository.
46+
- [ ] :ok: All changes should be compatible with the latest stable version of Julia.
47+
- [ ] :thought_balloon: I have commented liberally for any complex pieces of internal code.

‎CODE_OF_CONDUCT.md

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Etiquette and conduct in BioJulia
2+
3+
As you interact with other members of the BioJulia group, or make contributions
4+
you may have revisions and suggestions on your pull request from BioJulia members
5+
or others which they want to be implemented before they will merge your pull request.
6+
7+
You may also have disagreements with people on the forums or chats maintained by
8+
BioJulia.
9+
10+
In order to keep BioJulia a civil and enjoyable place, where technical disagreements
11+
and issues can be discussed and resolved in a mature and constructive way, we
12+
outline three principles of etiquette we expect members and contributors to abide by.
13+
14+
Anybody violating these principles in order to upset any member or contributor
15+
may be flagged to the BioJulia admins who will decide on an appropriate
16+
course of action. This includes locking conversations for cool-off periods, or
17+
even bans of individuals.
18+
19+
This statement on etiquette is not an exhaustive list of things that you can or can’t do.
20+
Rather, it is a statement of our spirit and attitude towards interacting with each other.
21+
22+
This statement applies in all spaces managed by the BioJulia organisation.
23+
This includes any gitter, mailing lists, issue trackers, repositories, or any
24+
other forums used by BioJulia for communication (such as Skype, Google Hangouts, etc).
25+
It also applies in real-world events and spaces organised by BioJulia.
26+
27+
## The principles of etiquette
28+
29+
### 1. Be welcoming, friendly and patient.
30+
31+
Be welcoming. We strive to welcome and support any individual participating in
32+
BioJulia activities to any extent (from developing code, to support seeking
33+
users). We have even been known to have a few members on our Gitter who are not
34+
Biologists, but they enjoy the forum, like what we do, and stick around for the
35+
programming chat. All are welcome (yes including _you_! :smile:).
36+
37+
### 2. Be considerate.
38+
39+
Your work will be used by other people, and you in turn will depend on the work
40+
of others. From any code you make, to any support questions you ask or answer!
41+
Any decision you take will affect users and colleagues, and you should take
42+
those consequences into account when making decisions.
43+
44+
Remember that we're a world-wide community, so you might not be communicating
45+
in someone else's primary language.
46+
47+
### 3. Be respectful.
48+
49+
Not all of us will agree all the time, but disagreement is no excuse for poor
50+
behaviour and poor manners. We might all experience some frustration now and then,
51+
but we cannot allow that frustration to turn into a personal attack.
52+
It’s important to remember that a community where people feel uncomfortable or
53+
threatened is not a productive or fun community.
54+
Members of the BioJulia community should be respectful when dealing with other
55+
members as well as with people outside the BioJulia community.
56+
57+
Please do not insult or put down other participants.
58+
Harassment and other exclusionary behaviour is not acceptable.
59+
This includes, but is not limited to:
60+
- Violent threats or language directed against another person.
61+
- Prejudiced, bigoted, or intolerant, jokes and language.
62+
- Posting sexually explicit or violent material.
63+
- Posting (or threatening to post) other people's personally identifying
64+
information ("doxing").
65+
- Personal insults, especially those using racist or sexist terms.
66+
- Unwelcome sexual attention.
67+
- Advocating for, or encouraging, any of the above behaviour.
68+
- Repeated harassment of others. In general, if someone asks you to stop,
69+
then stop.
70+
71+
When we disagree, try to understand why.
72+
Disagreements, both social and technical, happen all the time and this
73+
community is unlikely to be any exception!
74+
It is important that we resolve disagreements and differing views constructively.
75+
Different people have different perspectives on issues.
76+
Being unable to understand why someone holds a viewpoint doesn’t mean that
77+
they’re wrong.
78+
Don’t forget that it is human to err and blaming each other doesn’t get us
79+
anywhere.
80+
Instead, focus on helping to resolve issues and learning from mistakes.
81+
82+
Assume the person you have a disagreement with really does want the best for
83+
BioJulia, just as you do.
84+
Therefore, if you are ever unsure what the meaning or tone of a comment may be,
85+
in the first instance, assume your fellow BioJulia member is acting in good
86+
faith, this may well be a mistake in communication
87+
(with the scientific community as diverse as it is, such mis-steps are likely!).
88+
If you are comfortable doing so, ask them to clarify what they mean or to rephrase
89+
their point. If you don't feel comfortable doing this, or if it is clear the
90+
behaviour is hostile and not acceptable, please report it (see next section).
91+
92+
## Is someone behaving inappropriately?
93+
94+
If you are affected by the behaviour of a member or contributor of BioJulia,
95+
we ask that you report it by contacting the
96+
[BioJulia Admin Team](https://github.com/orgs/BioJulia/teams/admin/members)
97+
collectively, by emailing [[email protected]]([email protected]).
98+
They will get back to you and begin to resolve the situation.
99+
In some cases we may determine that a public statement will need to be made.
100+
If that's the case, the identities of all involved will remain
101+
confidential unless those individuals instruct us otherwise.
102+
103+
Ensure to include in your email:
104+
105+
- Your contact info (so we can get in touch with you if we need to follow up).
106+
107+
- Names (real, nicknames, or pseudonyms) of any individuals involved.
108+
If there were other witnesses besides you, please try to include them as well.
109+
110+
- When and where the incident occurred. Please be as specific as possible.
111+
112+
- Your account of what occurred. If there is a publicly available record
113+
(e.g. a mailing list archive or a public IRC logger) please include a link.
114+
115+
- Any extra context you believe existed for the incident.
116+
117+
- If you believe this incident is ongoing.
118+
119+
- Any other information you believe we should have.s

0 commit comments

Comments
 (0)