-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
AdamMiltonBarker
committed
Sep 18, 2019
1 parent
70beff4
commit 3ed54b4
Showing
13 changed files
with
285 additions
and
151 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 |
---|---|---|
@@ -1,86 +1,138 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via a [repo issue](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues "repo issue")issue before making a change. | ||
![Contributing to the Peter Moss Acute Myeloid/Lymphoblastic Leukemia AI Research Project](Media/Images/Page-Banner.png) | ||
We encourage students to submit their Unit Projects to this repository. Please follow the steps below to do so. | ||
|
||
Please note we have a code of conduct, please follow it in all your interactions with the project. | ||
If you would like to volunteer to the research project or student program as a professional, please use the contact form and select **Professional Volunteer**. | ||
|
||
# Bug Reports | ||
|
||
If you would like to contribute bug fixes or make the team aware of bugs you have identified in the project, please raise a **Bug report** issue in the [Acute Myeloid/Lymphoblastic Leukemia Classifiers repository issues](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues/new/choose) section. A template is provided that will allow you to provide your suggestions for your bug report / bug fix(es) which will be reviewed by the team who will communicate through your issue. | ||
|
||
## Terminal & Git | ||
|
||
Navigate to the directory you want to clone the project to and use the following command: | ||
|
||
``` | ||
$ git clone https://www.github.com/YourForkURL.git | ||
``` | ||
|
||
# Set up your local directory | ||
|
||
Now you have cloned the project, create your student directory locally. To do this navigate to your cloned copy of your fork, this will be your project and Github. | ||
|
||
# Github Issues | ||
|
||
![Feature Proposal](Media/Images/Contributing-Feature-Proposal.jpg) | ||
|
||
## Bug reports | ||
|
||
If you would like to contribute bug fixes or make the team aware of bugs you have identified in the project, please raise a **Bug report** issue in the [Issues section](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues/new/choose) section. A template is provided that will allow you to provide your suggestions for your bug report / bug fix(es) which will be reviewed by the team who will communicate through your issue. | ||
|
||
## Feature requests | ||
|
||
If you would like to contribute by suggesting features for the project, please raise a **Feature request** issue in the [Acute Myeloid/Lymphoblastic Leukemia Classifiers repository issues](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues/new/choose) section. A template is provided that will allow you to provide your suggestions for your feature request which will be reviewed by the team who will communicate through your issue. | ||
|
||
## Feature proposals | ||
|
||
If you would like to contribute new features to the project, please raise a **Feature proposal** issue in the [Acute Myeloid/Lymphoblastic Leukemia Classifiers repository issues](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues/new/choose) section. A template is provided that will allow you to provide your suggestions for your feature proposal which will be reviewed by the team who will communicate through your issue. | ||
|
||
| ||
|
||
# Push changes to forked repository | ||
|
||
![Push changes to forked repository](Media/Images/Contributing-Commit-Push.jpg) | ||
When you have made your changes to your forked repo, you need to push them to your forked repository. This process requires a commit with a message about what your commit is, and then finally a push to the repository which will place your changes or created files to your forked repository. | ||
|
||
| ||
|
||
# Pull requests | ||
|
||
![Pull requests](Media/Images/Contributing-Pull-Requests.jpg) | ||
When you are satisfied with your changes you can submit a pull request that will request that your changes be pulled into the latest development branch. | ||
|
||
## Pull Request Process | ||
|
||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a | ||
build. | ||
2. Update the README.md with details of changes. | ||
3. Increase the version numbers in any examples files and the README.md to the new version that this | ||
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). | ||
4. Your pull request will be merged once approved by the team. | ||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. | ||
2. Update all related README.md files with details of changes. | ||
3. Add new README.md files for new directories. | ||
4. Ensure that your READMEs, documentation and code match the format/design of the rest of the repoistory. | ||
5. Include the project header banner on all documentation pages / READMEs. | ||
6. Incude the Contributing, Versioning, Licensing, Bugs/Issues information in all READMEs and documentation. | ||
7. Submit your Pull Request with an accurate descrription of the changes you have made. | ||
8. Your Pull Request will be reviewed by the team. | ||
|
||
| ||
|
||
# Code of conduct | ||
|
||
## Code of Conduct | ||
Please note we have a code of conduct, please follow it in all your interactions with the project. | ||
|
||
| ||
|
||
## Our Pledge | ||
|
||
### Our Pledge | ||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
| ||
|
||
### Our Standards | ||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
### Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
### Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
### Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at github@tassai.tech. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
### Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at [http://contributor-covenant.org/version/1/4][version] | ||
- The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
| ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
| ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
| ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at github@tassai.tech. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
||
| ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
| ||
|
||
# Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
# Versioning | ||
|
||
We use SemVer for versioning. For the versions available, see [Releases](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/releases "Releases"). | ||
|
||
# License | ||
|
||
This project is licensed under the **MIT License** - see the [LICENSE](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/blob/master/LICENSE "LICENSE") file for details. | ||
|
||
# Bugs/Issues | ||
|
||
We use the [repo issues](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues "repo issues") to track bugs and general requests related to using this project. |
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 |
---|---|---|
@@ -1,40 +1,76 @@ | ||
# Acute Myeloid/Lymphoblastic Leukemia AI Research Center Archive | ||
![Peter Moss Acute Myeloid/Lymphoblastic Leukemia AI Research Project](Media/Images/banner.png) | ||
|
||
![Peter Moss Acute Myeloid/Lymphoblastic Leukemia AI Research Project Archive](Media/Images/Page-Banner.png) | ||
|
||
The Acute Myeloid/Lymphoblastic Leukemia AI Research Center Archive provides an archive of all Acute Myeloid/Lymphoblastic Leukemia related research centers that we come across during research and development. | ||
|
||
# Florida, USA | ||
|
||
## Moffitt Cancer Center, Tampa Florida | ||
Moffitt is dedicated to one lifesaving mission: to contribute to the prevention and cure of cancer. | ||
|
||
__PHONE:__ +1 888-663-3488 | ||
__WEBSITE:__ [Moffitt.org](https://moffitt.org "Moffitt.org") | ||
Moffitt is dedicated to one lifesaving mission: to contribute to the prevention and cure of cancer. Moffitt assisted Peter during his year long battle with AML. | ||
|
||
**PHONE:** +1 888-663-3488 | ||
**WEBSITE:** [Moffitt.org](https://moffitt.org "Moffitt.org") | ||
|
||
## Hematology and Oncology, Port St Lucie, Florida | ||
|
||
A private physician group specializing in Hematology and Oncology. Providing consultation, treatment, and follow-up care to patients referred to our specialty by the primary care physicians of the Treasure Coast and surrounding communities. The Port St Lucie Office was where Peter received his vidaza treatments and blood transfusions. | ||
|
||
**PHONE:** +1 772-335-5666 | ||
**WEBSITE:** [hemoncfl.com](https://www.hemoncfl.com/locations/#port "hemoncfl.com") | ||
|
||
# Barcelona, Spain | ||
|
||
## Josep Carreras Leukaemia Research Institute, Barcelona, Spain | ||
|
||
In 2010 the Josep Carreras Foundation, together with the Generalitat de Catalunya (Government of Catalonia), launched an historic and unprecedented project: the first European research centre devoted exclusively to leukaemia and other malignant blood diseases, and one of the few that exist in the world. | ||
|
||
__PHONE:__ (+34) 93 557 2800 | ||
__WEBSITE:__ [CarrerasResearch.org](http://www.carrerasresearch.org/en "CarrerasResearch.org") | ||
**PHONE:** (+34) 93 557 2800 | ||
**WEBSITE:** [CarrerasResearch.org](http://www.carrerasresearch.org/en "CarrerasResearch.org") | ||
|
||
## Hospital Clínic Barcelona, Barcelona, Spain | ||
|
||
Hospital Clínic Barcelona iks a Leukemia research center Barcelona. Keep up to date with what is happening on the official Hospital Clínic de Barcelona blogThanks to Toni for sharing the link! | ||
|
||
__WEBSITE:__ [HospitalClinic.org](http://blog.hospitalclinic.org/en/tag/leucemia-en "HospitalClinic.org") | ||
**WEBSITE:** [HospitalClinic.org](http://blog.hospitalclinic.org/en/tag/leucemia-en "HospitalClinic.org") | ||
|
||
# Community Driven | ||
|
||
The project was initially create with the hope other developers and people in the medical industry may find the software and tutorials useful and may contribute back to the Github community helping improve the project. Feel free to submit pull requests with your suggested edits / bug fixes / additions to the related repositories on Github. | ||
|
||
# Contributing | ||
|
||
We welcome contributions of the project. Please read [CONTRIBUTING.md](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/blob/master/CONTRIBUTING.md "CONTRIBUTING.md") for details on our code of conduct, and the process for submitting pull requests. | ||
|
||
# Versioning | ||
|
||
We use SemVer for versioning. For the versions available, see [Releases](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/releases "Releases"). | ||
|
||
# License | ||
|
||
This project is licensed under the **MIT License** - see the [LICENSE](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/blob/master/LICENSE "LICENSE") file for details. | ||
|
||
# Bugs/Issues | ||
|
||
We use the [repo issues](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues "repo issues") to track bugs and general requests related to using this project. | ||
|
||
# Community Driven | ||
|
||
The project was initially created with the hope other developers and people in the medical industry may find the software and tutorials useful, and may contribute back to the Github community helping improve the project. Feel free to submit pull requests with your suggested edits / bug fixes / additions to the related repositories on Github. | ||
|
||
# Contributing | ||
|
||
We welcome contributions of the project. Please read [CONTRIBUTING.md](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/blob/master/CONTRIBUTING.md "CONTRIBUTING.md") for details on our code of conduct, and the process for submitting pull requests. | ||
|
||
# Versioning | ||
|
||
We use SemVer for versioning. For the versions available, see [Releases](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/releases "Releases"). | ||
|
||
# License | ||
|
||
This project is licensed under the **MIT License** - see the [LICENSE](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/blob/master/LICENSE "LICENSE") file for details. | ||
|
||
# Bugs/Issues | ||
We use the [repo issues](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues "repo issues") to track bugs and general requests related to using this project. | ||
|
||
We use the [repo issues](https://github.com/AMLResearchProject/AML-ALL-Research-Archive/issues "repo issues") to track bugs and general requests related to using this project. |
Oops, something went wrong.