From 2d1bc4c8f274cf1c7b02a2dc94792c53e606cf71 Mon Sep 17 00:00:00 2001 From: ClaudiaSL Date: Fri, 28 Jan 2022 08:05:38 -0600 Subject: [PATCH 1/2] added contributing file --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..429a27fb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to PhyloNetworks + +The following guidelines are designed for contributors of `PhyloNetworks`. + +## Reporting Issues and Questions + +For reporting a bug, a failed function or requesting a new feature, you can simply open an issue in [the issue tracker](https://github.com/crsl4/PhyloNetworks.jl/issues). If you are reporting a bug, please also include a minimal code example or all relevant information for us to replicate the issue. + +For general questions, make sure to check out the [google user group](https://groups.google.com/g/phylonetworks-users). If you cannot find answers to your question, please post a new question. We do our best to reply in a timely fashion, but we are undermanned so we appreciate your patience. + +## Contributing Code + +To make contributions to `PhyloNetworks`, you need to set up your [GitHub](https://github.com/) account (if you do not have one) and request your change(s) or contribution(s) via a pull request against the `master` branch of `PhyloNetworks` from a non-master branch in your fork. Using a non-master branch on your end will allow developers with push access to `PhyloNetworks` to make edits to the branch (in case we want to work collaboratively on the new code). + +Please use the following steps: + +1. Fork the `PhyloNetworks` repository to your GitHub account +2. Clone your fork locally with `git clone` +3. Create a new branch with a name that describes your contribution. For example, if your contribution is fixing a bug in `readTopology`, your new branch can be named `fix-bug-readTopology`. You can create it and switch with: +``` +git checkout -b fix-bug-readTopology +``` +4. Make your changes in this new branch; make sure that your code passes all the tests +5. Push your changes to your fork +6. [Submit a pull request](https://github.com/crsl4/PhyloNetworks.jl/pulls) against the `master` branch in `PhyloNetworks`. Make sure that your code passes all the automatic tests and that it is not in conflict with the current status of `master` + +Please make sure to follow the Julia package guidelines and conventions on your code. `PhyloNetworks` was created before these conventions were catalyzed, but we are attempting to follow them going forward. + +To learn more about the Julia conventions, check out the following links: + +- [Julia package development](http://web.mit.edu/julia_v0.6.0/julia/share/doc/julia/html/en/manual/packages.html#Package-Development-1) +- [Creating Julia packages](https://pkgdocs.julialang.org/v1/creating-packages/) +- [Julia style guide](https://docs.julialang.org/en/v1/manual/style-guide/) \ No newline at end of file From 9398b4017afef635ab91e6c833e2d95964af16a8 Mon Sep 17 00:00:00 2001 From: Cecile Ane Date: Fri, 28 Jan 2022 18:18:42 -0600 Subject: [PATCH 2/2] links added; more explicit ask for doc and tests --- CONTRIBUTING.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 429a27fb..ea1f5078 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,23 +4,31 @@ The following guidelines are designed for contributors of `PhyloNetworks`. ## Reporting Issues and Questions -For reporting a bug, a failed function or requesting a new feature, you can simply open an issue in [the issue tracker](https://github.com/crsl4/PhyloNetworks.jl/issues). If you are reporting a bug, please also include a minimal code example or all relevant information for us to replicate the issue. +For reporting a bug, a failed function or requesting a new feature, you can simply open an issue in [the issue tracker](https://github.com/crsl4/PhyloNetworks.jl/issues). +First, seach through existing issues (open or closed) that might have the answer to your question. +If you are reporting a bug, please also include a minimal code example or all relevant information for us to replicate the issue. For general questions, make sure to check out the [google user group](https://groups.google.com/g/phylonetworks-users). If you cannot find answers to your question, please post a new question. We do our best to reply in a timely fashion, but we are undermanned so we appreciate your patience. ## Contributing Code -To make contributions to `PhyloNetworks`, you need to set up your [GitHub](https://github.com/) account (if you do not have one) and request your change(s) or contribution(s) via a pull request against the `master` branch of `PhyloNetworks` from a non-master branch in your fork. Using a non-master branch on your end will allow developers with push access to `PhyloNetworks` to make edits to the branch (in case we want to work collaboratively on the new code). +To make contributions to `PhyloNetworks`, you need to set up your [GitHub](https://github.com/) account (if you do not have one) and request your change(s) or contribution(s) via a pull request against the `master` branch of `PhyloNetworks` from a non-master branch in your fork. +Using a non-master branch on your end will give developers push access to your +branch to make edits to it (in case we want to work collaboratively on the new code). Please use the following steps: 1. Fork the `PhyloNetworks` repository to your GitHub account 2. Clone your fork locally with `git clone` 3. Create a new branch with a name that describes your contribution. For example, if your contribution is fixing a bug in `readTopology`, your new branch can be named `fix-bug-readTopology`. You can create it and switch with: -``` -git checkout -b fix-bug-readTopology -``` -4. Make your changes in this new branch; make sure that your code passes all the tests + ``` + git checkout -b fix-bug-readTopology + ``` +4. Make your changes on this new branch. + Write a [docstring](https://docs.julialang.org/en/v1/manual/documentation/) + and add one or more tests for each function. + Make sure that your code passes all the + [tests](https://pkgdocs.julialang.org/v1/managing-packages/#Testing-packages). 5. Push your changes to your fork 6. [Submit a pull request](https://github.com/crsl4/PhyloNetworks.jl/pulls) against the `master` branch in `PhyloNetworks`. Make sure that your code passes all the automatic tests and that it is not in conflict with the current status of `master` @@ -30,4 +38,4 @@ To learn more about the Julia conventions, check out the following links: - [Julia package development](http://web.mit.edu/julia_v0.6.0/julia/share/doc/julia/html/en/manual/packages.html#Package-Development-1) - [Creating Julia packages](https://pkgdocs.julialang.org/v1/creating-packages/) -- [Julia style guide](https://docs.julialang.org/en/v1/manual/style-guide/) \ No newline at end of file +- [Julia style guide](https://docs.julialang.org/en/v1/manual/style-guide/)