-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #166 from SuperDARN/release/2.1
Release/2.1
- Loading branch information
Showing
48 changed files
with
2,130 additions
and
309 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
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,77 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making participation in pyDARN and | ||
| DAWG a harassment-free experience for everyone, regardless of age, body | ||
| size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
| level of experience, education, socio-economic status, nationality, personal | ||
| appearance, race, religion, or sexual identity and orientation. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| 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 | ||
| * Please see [communication guidelines](https://pydarn.readthedocs.io/en/latest/dev/communication/) for more examples | ||
|
|
||
| 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 | ||
|
|
||
| [PyDARN/DAWG leaders/chairs](https://superdarn.github.io/dawg/about) (please see [DAWG charter](https://superdarn.github.io/dawg/documents/DAWG_Charter/) on pyDARN/DAWG leaders) 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. | ||
|
|
||
| [PyDARN/DAWG leaders/chairs](https://superdarn.github.io/dawg/about) have the right and responsibility to remove, edit, or | ||
| reject comments, commits, code, wiki edits, README edits, readthedocs edits, | ||
| issues, and other contributions that are not aligned to this Code of Conduct or the scope of pyDARN, | ||
| 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 pyDARN spaces and in public spaces | ||
| when an individual is representing the pyDARN/DAWG or its community. Examples of | ||
| representing pyDARN or DAWG include: using an official pyDARN name or logo, | ||
| publishing work in an official journal or conference, posting via an official website or online conference, | ||
| or acting as an appointed representative at an online or offline conference or workshop. | ||
| Representation of pyDARN may be further defined and clarified by pyDARN maintainers. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the [pydarn team lead at or contacting | ||
| the DAWG chairs](https://superdarn.github.io/dawg/about). All complaints will be reviewed and investigated and will result in a response that | ||
| is deemed necessary and appropriate to the circumstances. The pyDARN team is | ||
| obligated to maintain confidentiality with regard to the reporter of an incident. | ||
| Further details of specific enforcement policies may be posted separately. | ||
| Please see [communication guidelines](https://pydarn.readthedocs.io/en/latest/dev/communication/) and [reporting guidelines](https://pydarn.readthedocs.io/en/latest/dev/communication/#disputes-procedure) for more information. | ||
|
|
||
| pyDARN developers who do not follow or enforce the Code of Conduct in good | ||
| faith may face temporary or permanent repercussions as determined by [DAWG chairs](https://superdarn.github.io/dawg/about). | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
| available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
|
|
||
| For answers to common questions about this code of conduct, see | ||
| https://www.contributor-covenant.org/faq |
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
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,69 @@ | ||
| <!--Copyright (C) 2021 SuperDARN Canada, University of Saskatchewan | ||
| Author(s): Marina Schmidt | ||
| Modifications: | ||
| Disclaimer: | ||
| pyDARN is under the LGPL v3 license found in the root directory LICENSE.md | ||
| Everyone is permitted to copy and distribute verbatim copies of this license | ||
| document, but changing it is not allowed. | ||
| This version of the GNU Lesser General Public License incorporates the terms | ||
| and conditions of version 3 of the GNU General Public License, supplemented by | ||
| the additional permissions listed below. | ||
| --> | ||
|
|
||
|
|
||
| ## Branching | ||
|
|
||
| In git, "branches" are used to make changes to the code without affecting the main codebase or the work of other developers. Once the changes on a new branch have been [tested](testing.md) and [reviewed](code_review.md) in a ["pull request"](PR.md), the new branch is merged into the main codebase. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| !!! Note | ||
| Before you start writing new code, please create a new issue to describe what you are planning to do, and "assign" the issue to yourself. This lets other developers know what you are working on. See [issues](issues.md) | ||
|
|
||
| 1. Clone the pydarn repo: | ||
|
|
||
| git clone git@github.com:SuperDARN/pydarn.git | ||
|
|
||
| It is recommended by GitHub to create a [SSH key](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) | ||
|
|
||
| 2. Change to the `pydarn` folder | ||
|
|
||
| cd pydarn | ||
|
|
||
| * Update the code | ||
|
|
||
| git fetch | ||
| git pull origin master | ||
|
|
||
| * Decide what branch to break off from: | ||
| * HOTFIX: a fix that needs to be in master ASAP then branch from `master` | ||
| * Documentation: existing main documentation with an update then branch from `master` | ||
| * New Documentation: documentation that doesn't exist in the main documentation then branch from `develop` | ||
| * New code/fix that can wait for a release then branch from `develop` | ||
| * Removing legacy code then branch from `develop` | ||
| * Code based on another branch then branch from that branch name | ||
|
|
||
| git checkout <branch name> | ||
|
|
||
| * Decide on the new branch name. It is recommended to use the following Prefixes: | ||
| * HOTFIX/ : a bug that needs to be fixed ASAP and pushed to `master` | ||
| * FIX/ : a bug fix that can wait to be released | ||
| * EHN/ : an enhancement or new feature to the `develop` code | ||
| * DOC/ : new or updating existing documentation | ||
| * DEP/ : deprecating code from the codebase | ||
|
|
||
| git checkout -b <prefix/><branch name> | ||
|
|
||
| * Now you have created your own branch locally. Make the modifications to the code on this branch, and then run the following commands to commit the changes: | ||
|
|
||
| git add <file changed> | ||
| git commit -m <brief description of the change> | ||
|
|
||
| * Now "push" the changes to GitHub: | ||
|
|
||
| git push origin <branch name> | ||
|
|
||
| * Repeat the above commands above as you work on the code changes | ||
| * Once you have completed, documented, and tested your code then you can create a pull request, see [pull request](PR.md) |
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,13 @@ | ||
| # Communication Guidelines | ||
|
|
||
| pyDARN is under the Data Analysis Working Group that has set up guidelines on [communication](https://superdarn.github.io/dawg/documents/communication-guidelines/) to encourage a positive collaborative environment. | ||
| Please follow these guidelines when commenting and reviewing code on GitHub. | ||
|
|
||
| Also please read workflow documentation on issues and [pull requests](PR.md) to communicate effectively for collaborative work. | ||
|
|
||
| ## Disputes Procedure | ||
|
|
||
| If members have a dispute that violates the communication guidelines, and creates a negative environment in the pyDARN community, please follow this procedure to resolve the conflict: | ||
| 1. Please try resolve the matter between each member offline. | ||
| 2. If the dispute cannot be resolved, or the environment has become toxic and overwhelming, please contact the [lead developer for pyDARN](https://pydarn.readthedocs.io/en/latest/). | ||
| 3. If the dispute cannot be resolved, involves the lead developer, or breaches the [DAWG charter](https://superdarn.github.io/dawg/documents/DAWG_Charter/) please contact the [chairs of DAWG](https://superdarn.github.io/dawg/about/). |
Oops, something went wrong.