This repository has been archived by the owner on Aug 26, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This was generated by an automatic rollout script I created that makes all the contributing files and github templates consistent across packages
- Loading branch information
Ben J. Ward
committed
Jun 15, 2018
1 parent
08a5bc7
commit 2bad57c
Showing
4 changed files
with
937 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
<!--- Provide a general summary of the issue in the Title above --> | ||
|
||
> _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._ | ||
## Expected Behavior | ||
<!--- If you're describing a bug, tell us what you expect to happen --> | ||
<!--- If you're suggesting a change/improvement, tell us how it should work --> | ||
|
||
## Current Behavior | ||
<!--- If describing a bug, tell us what happens instead of the expected behavior --> | ||
<!--- If suggesting a change/improvement, explain the difference from current behavior --> | ||
|
||
## Possible Solution / Implementation | ||
<!--- If describing a bug, suggest a fix/reason for the bug (optional) --> | ||
<!--- If you're suggesting a change/improvement, suggest ideas how to implement the addition or change --> | ||
|
||
## Steps to Reproduce (for bugs) | ||
<!--- You may include copy/pasteable snippets or a list of steps to reproduce the bug --> | ||
1. | ||
2. | ||
3. | ||
4. | ||
|
||
<!--- Optionally, provide a link to a live example --> | ||
<!--- You can use [this tool](https://www.cockos.com/licecap/) --> | ||
<!--- ...Or [this tool](https://github.com/colinkeenan/silentcast) --> | ||
<!--- ...Or [this tool](https://github.com/GNOME/byzanz) on Linux --> | ||
|
||
## Context | ||
<!--- How has this issue affected you? What are you trying to accomplish? --> | ||
<!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
|
||
## Your Environment | ||
<!--- Include as many relevant details about the environment you experienced the bug in --> | ||
- Package Version used: | ||
- Julia Version used: | ||
- Operating System and version (desktop or mobile): | ||
- Link to your project: | ||
|
||
<!-- Can you list installed packages here? --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# A clear and descriptive title (No issue numbers please) | ||
|
||
> _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._ | ||
## Types of changes | ||
|
||
This PR implements the following changes: | ||
_(Please tick any or all of the following that are applicable)_ | ||
|
||
* [ ] :sparkles: New feature (A non-breaking change which adds functionality). | ||
* [ ] :bug: Bug fix (A non-breaking change, which fixes an issue). | ||
* [ ] :boom: Breaking change (fix or feature that would cause existing functionality to change). | ||
|
||
## :clipboard: Additional detail | ||
|
||
- If you have implemented new features or behaviour | ||
- **Provide a description of the addition** in as many details as possible. | ||
|
||
- **Provide justification of the addition**. | ||
|
||
- **Provide a runnable example of use of your addition**. This lets reviewers | ||
and others try out the feature before it is merged or makes it's way to release. | ||
|
||
- If you have changed current behaviour... | ||
- **Describe the behaviour prior to you changes** | ||
|
||
- **Describe the behaviour after your changes** and justify why you have made the changes, | ||
Please describe any breakages you anticipate as a result of these changes. | ||
|
||
- **Does your change alter APIs or existing exposed methods/types?** | ||
If so, this may cause dependency issues and breakages, so the maintainer | ||
will need to consider this when versioning the next release. | ||
|
||
- If you are implementing changes that are intended to increase performance, you | ||
should provide the results of a simple performance benchmark exercise | ||
demonstrating the improvement. Especially if the changes make code less legible. | ||
|
||
## :ballot_box_with_check: Checklist | ||
|
||
- [ ] :art: The changes implemented is consistent with the [julia style guide](https://docs.julialang.org/en/stable/manual/style-guide/). | ||
- [ ] :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/). | ||
- [ ] :blue_book: I have added or updated relevant user and developer manuals/documentation in `docs/src/`. | ||
- [ ] :ok: There are unit tests that cover the code changes I have made. | ||
- [ ] :ok: The unit tests cover my code changes AND they pass. | ||
- [ ] :pencil: I have added an entry to the `[UNRELEASED]` section of the manually curated `CHANGELOG.md` file for this repository. | ||
- [ ] :ok: All changes should be compatible with the latest stable version of Julia. | ||
- [ ] :thought_balloon: I have commented liberally for any complex pieces of internal code. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
# Etiquette and conduct in BioJulia | ||
|
||
As you interact with other members of the BioJulia group, or make contributions | ||
you may have revisions and suggestions on your pull request from BioJulia members | ||
or others which they want to be implemented before they will merge your pull request. | ||
|
||
You may also have disagreements with people on the forums or chats maintained by | ||
BioJulia. | ||
|
||
In order to keep BioJulia a civil and enjoyable place, where technical disagreements | ||
and issues can be discussed and resolved in a mature and constructive way, we | ||
outline three principles of etiquette we expect members and contributors to abide by. | ||
|
||
Anybody violating these principles in order to upset any member or contributor | ||
may be flagged to the BioJulia admins who will decide on an appropriate | ||
course of action. This includes locking conversations for cool-off periods, or | ||
even bans of individuals. | ||
|
||
This statement on etiquette is not an exhaustive list of things that you can or can’t do. | ||
Rather, it is a statement of our spirit and attitude towards interacting with each other. | ||
|
||
This statement applies in all spaces managed by the BioJulia organisation. | ||
This includes any gitter, mailing lists, issue trackers, repositories, or any | ||
other forums used by BioJulia for communication (such as Skype, Google Hangouts, etc). | ||
It also applies in real-world events and spaces organised by BioJulia. | ||
|
||
## The principles of etiquette | ||
|
||
### 1. Be welcoming, friendly and patient. | ||
|
||
Be welcoming. We strive to welcome and support any individual participating in | ||
BioJulia activities to any extent (from developing code, to support seeking | ||
users). We have even been known to have a few members on our Gitter who are not | ||
Biologists, but they enjoy the forum, like what we do, and stick around for the | ||
programming chat. All are welcome (yes including _you_! :smile:). | ||
|
||
### 2. Be considerate. | ||
|
||
Your work will be used by other people, and you in turn will depend on the work | ||
of others. From any code you make, to any support questions you ask or answer! | ||
Any decision you take will affect users and colleagues, and you should take | ||
those consequences into account when making decisions. | ||
|
||
Remember that we're a world-wide community, so you might not be communicating | ||
in someone else's primary language. | ||
|
||
### 3. Be respectful. | ||
|
||
Not all of us will agree all the time, but disagreement is no excuse for poor | ||
behaviour and poor manners. We might all experience some frustration now and then, | ||
but we cannot allow that frustration to turn into a personal attack. | ||
It’s important to remember that a community where people feel uncomfortable or | ||
threatened is not a productive or fun community. | ||
Members of the BioJulia community should be respectful when dealing with other | ||
members as well as with people outside the BioJulia community. | ||
|
||
Please do not insult or put down other participants. | ||
Harassment and other exclusionary behaviour is not acceptable. | ||
This includes, but is not limited to: | ||
- Violent threats or language directed against another person. | ||
- Prejudiced, bigoted, or intolerant, jokes and language. | ||
- Posting sexually explicit or violent material. | ||
- Posting (or threatening to post) other people's personally identifying | ||
information ("doxing"). | ||
- Personal insults, especially those using racist or sexist terms. | ||
- Unwelcome sexual attention. | ||
- Advocating for, or encouraging, any of the above behaviour. | ||
- Repeated harassment of others. In general, if someone asks you to stop, | ||
then stop. | ||
|
||
When we disagree, try to understand why. | ||
Disagreements, both social and technical, happen all the time and this | ||
community is unlikely to be any exception! | ||
It is important that we resolve disagreements and differing views constructively. | ||
Different people have different perspectives on issues. | ||
Being unable to understand why someone holds a viewpoint doesn’t mean that | ||
they’re wrong. | ||
Don’t forget that it is human to err and blaming each other doesn’t get us | ||
anywhere. | ||
Instead, focus on helping to resolve issues and learning from mistakes. | ||
|
||
Assume the person you have a disagreement with really does want the best for | ||
BioJulia, just as you do. | ||
Therefore, if you are ever unsure what the meaning or tone of a comment may be, | ||
in the first instance, assume your fellow BioJulia member is acting in good | ||
faith, this may well be a mistake in communication | ||
(with the scientific community as diverse as it is, such mis-steps are likely!). | ||
If you are comfortable doing so, ask them to clarify what they mean or to rephrase | ||
their point. If you don't feel comfortable doing this, or if it is clear the | ||
behaviour is hostile and not acceptable, please report it (see next section). | ||
|
||
## Is someone behaving inappropriately? | ||
|
||
If you are affected by the behaviour of a member or contributor of BioJulia, | ||
we ask that you report it by contacting the | ||
[BioJulia Admin Team](https://github.com/orgs/BioJulia/teams/admin/members) | ||
collectively, by emailing [admin@biojulia.net](admin@biojulia.net). | ||
They will get back to you and begin to resolve the situation. | ||
In some cases we may determine that a public statement will need to be made. | ||
If that's the case, the identities of all involved will remain | ||
confidential unless those individuals instruct us otherwise. | ||
|
||
Ensure to include in your email: | ||
|
||
- Your contact info (so we can get in touch with you if we need to follow up). | ||
|
||
- Names (real, nicknames, or pseudonyms) of any individuals involved. | ||
If there were other witnesses besides you, please try to include them as well. | ||
|
||
- When and where the incident occurred. Please be as specific as possible. | ||
|
||
- Your account of what occurred. If there is a publicly available record | ||
(e.g. a mailing list archive or a public IRC logger) please include a link. | ||
|
||
- Any extra context you believe existed for the incident. | ||
|
||
- If you believe this incident is ongoing. | ||
|
||
- Any other information you believe we should have.s |
Oops, something went wrong.