From 29cadc21f26ebaa08523a5ade1df65ecf87e3b9e Mon Sep 17 00:00:00 2001 From: sheridana Date: Fri, 13 May 2022 11:49:59 -0500 Subject: [PATCH 01/14] Add contributing draft --- docs/CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000..1bdb8a02c --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Contributing to SLEAP + +Thank you for contributing to SLEAP! (add link?) + +As our community grows it is important to adhere to a set of contribution guidelines. These guidelines may change as needed. Please feel free to propose changes in a pull request! + +#### Table Of Contents + +1) [Code of Conduct](#code-of-conduct) +2) [Contributing](#contributing) + * [Issues](#issues) + * [Discussions](#discussions) + * [Pull Requests](#pull-requests) +3) [Style Guides](#style-guides) +4) [Miscellaneous](#miscellaneous) + +## Code of Conduct + +Everyone contributing to SLEAP is governed by the (add code of conduct). As such, all are expected to abide by this code. Please report any unacceptable behavior to (add email). + +## Contributing + +Github has made it easy to separate issues from discussions. Generally speaking, if something warrants a pull request (e.g. bug fixes, TODOs) it should be submitted as an issue. Conversely, general questions about usage and improvement ideas should go into discussions. These both act as staging areas before adding the items to the SLEAP Roadmap. Once added to the Roadmap, items can be given priority, status, assignee(s), etc. + +### Issues + +TODO: add issue template then include example images here + +### Discussions + +TODO: add instructions, example + +### Pull Requests + +TODO: add instructions, example + +## Style Guides + +TODO: specific coding style guides - linting, pep, etc + +## Miscellaneous + +TODO: anything else? From 26778f4186565a154fb7d8bbde45e51e56fadcd8 Mon Sep 17 00:00:00 2001 From: sheridana Date: Fri, 13 May 2022 12:00:34 -0500 Subject: [PATCH 02/14] Add draft code of conduct --- docs/CODE_OF_CONDUCT.md | 46 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/CODE_OF_CONDUCT.md diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..e7fd891f0 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make 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 + +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 + +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 (TODO: add email). 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 [https://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ From 79a40fb2ddcb6ed15e120b0be8f8a650261b6081 Mon Sep 17 00:00:00 2001 From: sheridana Date: Fri, 13 May 2022 12:02:49 -0500 Subject: [PATCH 03/14] Link to code of conduct in contributing guide --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 1bdb8a02c..34be4032d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -16,7 +16,7 @@ As our community grows it is important to adhere to a set of contribution guidel ## Code of Conduct -Everyone contributing to SLEAP is governed by the (add code of conduct). As such, all are expected to abide by this code. Please report any unacceptable behavior to (add email). +Everyone contributing to SLEAP is governed by the [SLEAP Code of Conduct](CODE_OF_CONDUCT.md). As such, all are expected to abide by this code. Please report any unacceptable behavior to (add email). ## Contributing From 1e26df738574445f1a2c973ab8f405f5b3ee65d7 Mon Sep 17 00:00:00 2001 From: sheridana Date: Mon, 16 May 2022 14:39:10 -0500 Subject: [PATCH 04/14] Create draft issue template --- docs/ISSUE_TEMPLATE.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/ISSUE_TEMPLATE.md diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..992fe21f1 --- /dev/null +++ b/docs/ISSUE_TEMPLATE.md @@ -0,0 +1,28 @@ +# Issue Template + +## Description of issue + +* Please provide a clear and concise explanation of the issue + +## Expected behavior + +* Please provide a clear and concise explanation of the behavior you are expecting + +## Versions: +- OS + version [e.g Linux Ubuntu 18.04] +- Browser + version [e.g Firefox 100.0] +- SLEAP version [e.g v1.2.3] +- SLEAP installation method [e.g conda, pip] + +## Screenshots + +* Please share any relevant screenshots of the issue + +## Terminal Output + +* Please share the applicable error logs +* Optional: share output from `sleap-diagnostic` + +## Steps to Reproduce + +* If applicable, please provide detailed steps for reproducing the issue. From 9992316ebbce905c44e7174cbbd7d022ffe5e3d7 Mon Sep 17 00:00:00 2001 From: sheridana Date: Tue, 17 May 2022 11:53:46 -0700 Subject: [PATCH 05/14] Add discussions link to issue template --- docs/ISSUE_TEMPLATE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md index 992fe21f1..27e57c04d 100644 --- a/docs/ISSUE_TEMPLATE.md +++ b/docs/ISSUE_TEMPLATE.md @@ -1,5 +1,7 @@ # Issue Template +* Generally speaking, issues should consist of bugs in SLEAP that will require a pull request. For general questions and suggestions for enhancements, you can start a new discussion [here](https://github.com/talmolab/sleap/discussions) + ## Description of issue * Please provide a clear and concise explanation of the issue From 12da02bdb01374aca00c149a4b6c813c510728a2 Mon Sep 17 00:00:00 2001 From: sheridana Date: Fri, 20 May 2022 12:00:58 -0700 Subject: [PATCH 06/14] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 41 ++++++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 34be4032d..0d5ce1438 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to SLEAP -Thank you for contributing to SLEAP! (add link?) +Thank you for contributing to SLEAP! As our community grows it is important to adhere to a set of contribution guidelines. These guidelines may change as needed. Please feel free to propose changes in a pull request! @@ -16,7 +16,7 @@ As our community grows it is important to adhere to a set of contribution guidel ## Code of Conduct -Everyone contributing to SLEAP is governed by the [SLEAP Code of Conduct](CODE_OF_CONDUCT.md). As such, all are expected to abide by this code. Please report any unacceptable behavior to (add email). +Everyone contributing to SLEAP is governed by the [SLEAP Code of Conduct](CODE_OF_CONDUCT.md). As such, all are expected to abide by this code. Please report any unacceptable behavior to talmo@salk.edu. ## Contributing @@ -24,20 +24,43 @@ Github has made it easy to separate issues from discussions. Generally speaking, ### Issues -TODO: add issue template then include example images here +* Check [open/closed issues](https://github.com/talmolab/sleap/issues), [discussions](https://github.com/talmolab/sleap/discussions), and [sleap.ai help page](https://sleap.ai/help.html) to make sure issue doesn't already exist / has been solved +* Create new issue using the [issue template](https://github.com/talmolab/sleap/blob/arlo/contributing_guide/docs/ISSUE_TEMPLATE.md) ### Discussions -TODO: add instructions, example +* This is a place to go to ask questions and propose new ideas +* 3 categories: general, help, ideas + * help - having trouble with software, user experience issue, etc + * ideas - enhancements, things that would make the user experience nicer but not necessarily a problem with the code + * general - if it doesn't fall into help/ideas it goes here as long as it isn't bug fix (issue) ### Pull Requests -TODO: add instructions, example +1) install source code develop branch: https://sleap.ai/installation.html#conda-from-source +2) follow instructions to create conda env etc +3) create fork + * either work on develop branch in own fork or can create branch on either github or cli + * if creating a branch, use your name followed by a relevant keyword for your changes, eg: `git checkout -b john/some_issue` +4) make some changes to source code or additions that tackle the issue(s) +5) write [tests](https://github.com/talmolab/sleap/tree/develop/tests) + * can either write before pr or submit draft pr and then write tests to narrow down error prone lines + * the test(s) should go into relevant subtest folders to the proposed change(s) + * test(s) should aim to hit every point in the proposed change(s) - cover edge cases to best of your ability + * try to hit code coverage points +6) add files and commit (make sure to correct branch!) +7) create Draft PR (on github - follow instructions in template) + * make sure tests pass and code coverage is good + * if tests fail, repeat steps 4-7 +8) once draft pr looks good, submit a PR (hit `ready for review` button) + * optionally assign a reviewer on right of screen +9) if reviewer requests changes, repeat steps 4-8 +10) once reviewer signs off they will squash + merge ## Style Guides -TODO: specific coding style guides - linting, pep, etc +* linting - [black](https://black.readthedocs.io/en/stable/) version 21.6b0 (see [dev_requirements](https://github.com/talmolab/sleap/blob/develop/dev_requirements.txt) for any changes) +* coding - generally follow pep8, type hinting is encouraged -## Miscellaneous - -TODO: anything else? +#### Thank you for contributing to SLEAP! +:heart: From aed9d6e3f63849f61aa9031f369bd7981d177f3f Mon Sep 17 00:00:00 2001 From: sheridana Date: Mon, 23 May 2022 10:23:36 -0700 Subject: [PATCH 07/14] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0d5ce1438..e031e0744 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,7 +1,5 @@ # Contributing to SLEAP -Thank you for contributing to SLEAP! - As our community grows it is important to adhere to a set of contribution guidelines. These guidelines may change as needed. Please feel free to propose changes in a pull request! #### Table Of Contents @@ -12,7 +10,6 @@ As our community grows it is important to adhere to a set of contribution guidel * [Discussions](#discussions) * [Pull Requests](#pull-requests) 3) [Style Guides](#style-guides) -4) [Miscellaneous](#miscellaneous) ## Code of Conduct @@ -31,31 +28,30 @@ Github has made it easy to separate issues from discussions. Generally speaking, * This is a place to go to ask questions and propose new ideas * 3 categories: general, help, ideas - * help - having trouble with software, user experience issue, etc - * ideas - enhancements, things that would make the user experience nicer but not necessarily a problem with the code - * general - if it doesn't fall into help/ideas it goes here as long as it isn't bug fix (issue) + * **Help** - having trouble with software, user experience issue, etc + * **Ideas** - enhancements, things that would make the user experience nicer but not necessarily a problem with the code + * **General** - if it doesn't fall into help/ideas it goes here as long as it isn't bug fix (issue) ### Pull Requests -1) install source code develop branch: https://sleap.ai/installation.html#conda-from-source -2) follow instructions to create conda env etc -3) create fork +1) install source code [develop branch](https://sleap.ai/installation.html#conda-from-source) and follow instructions to create conda env etc +2) create fork * either work on develop branch in own fork or can create branch on either github or cli * if creating a branch, use your name followed by a relevant keyword for your changes, eg: `git checkout -b john/some_issue` -4) make some changes to source code or additions that tackle the issue(s) -5) write [tests](https://github.com/talmolab/sleap/tree/develop/tests) +3) make some changes to source code or additions that tackle the issue(s) +4) write [tests](https://github.com/talmolab/sleap/tree/develop/tests) * can either write before pr or submit draft pr and then write tests to narrow down error prone lines * the test(s) should go into relevant subtest folders to the proposed change(s) * test(s) should aim to hit every point in the proposed change(s) - cover edge cases to best of your ability * try to hit code coverage points -6) add files and commit (make sure to correct branch!) -7) create Draft PR (on github - follow instructions in template) +5) add files and commit (make sure to correct branch!) +6) create Draft PR (on github - follow instructions in template) * make sure tests pass and code coverage is good * if tests fail, repeat steps 4-7 -8) once draft pr looks good, submit a PR (hit `ready for review` button) +7) once draft pr looks good, submit a PR (hit `ready for review` button) * optionally assign a reviewer on right of screen -9) if reviewer requests changes, repeat steps 4-8 -10) once reviewer signs off they will squash + merge +8) if reviewer requests changes, repeat steps 4-8 +9) once reviewer signs off they will squash + merge ## Style Guides From e7e4d2e1306b7c338b7db277ff163a0f47bf2a35 Mon Sep 17 00:00:00 2001 From: sheridana Date: Mon, 23 May 2022 10:25:04 -0700 Subject: [PATCH 08/14] Add email to code of conduct --- docs/CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index e7fd891f0..dbf512e36 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at (TODO: add email). 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. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at talmo@salk.edu. 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. From e16aac5e16defbd5460b690c463c0ff2fb75a023 Mon Sep 17 00:00:00 2001 From: sheridana Date: Mon, 23 May 2022 10:54:08 -0700 Subject: [PATCH 09/14] Create bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 63 ++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..35b3cabaa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,63 @@ +--- +name: "\U0001F41B Bug report" +about: Create a report to help us repair something that is currently broken +labels: bug + +--- + + +### Bug description + + +#### Expected behaviour + + +#### Actual behaviour + + +### Your personal set up + + + - OS: + + - Browser: + + - Version(s): + + - SLEAP installation method (listed [here](https://sleap.ai/installation.html#)): + * [ ] [Conda from package](https://sleap.ai/installation.html#conda-package) + * [ ] [Conda from source](https://sleap.ai/installation.html#conda-from-source) + * [ ] [pip package](https://sleap.ai/installation.html#pip-package) + * [ ] [M1 Macs](https://sleap.ai/installation.html#m1-macs) + +-
Environment packages + + +``` +# paste output of `pip freeze` or `conda list` here +``` +
+ +-
Logs + + +``` +# paste relevant logs here, if any +``` +
+ +### Screenshots + + +### How to reproduce + + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error From c437f1d0d3c2ba4fc016d0ef7974f639cf681691 Mon Sep 17 00:00:00 2001 From: sheridana Date: Mon, 23 May 2022 11:05:33 -0700 Subject: [PATCH 10/14] Create config.yml --- .github/ISSUE_TEMPLATE/config.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..8eefd9899 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +contact_links: + - name: "\U0001F914 Ask any general questions relating to SLEAP" + url: https://github.com/talmolab/sleap/discussions/categories/help + about: Ask general questions or get help. + - name: "\U0001F4A1 Propose new features or enhancements for SLEAP" + url: https://github.com/talmolab/sleap/discussions/categories/ideas + about: Propose new features or enhancements. + - name: "\U0001F4DD See the SLEAP documentation" + url: https://sleap.ai + about: See the documentation From 5a4cd4cf78004bfafa6a1fe2365c44a19217b5d3 Mon Sep 17 00:00:00 2001 From: sheridana Date: Mon, 23 May 2022 11:08:12 -0700 Subject: [PATCH 11/14] Delete previous issue template --- docs/ISSUE_TEMPLATE.md | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 docs/ISSUE_TEMPLATE.md diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md deleted file mode 100644 index 27e57c04d..000000000 --- a/docs/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,30 +0,0 @@ -# Issue Template - -* Generally speaking, issues should consist of bugs in SLEAP that will require a pull request. For general questions and suggestions for enhancements, you can start a new discussion [here](https://github.com/talmolab/sleap/discussions) - -## Description of issue - -* Please provide a clear and concise explanation of the issue - -## Expected behavior - -* Please provide a clear and concise explanation of the behavior you are expecting - -## Versions: -- OS + version [e.g Linux Ubuntu 18.04] -- Browser + version [e.g Firefox 100.0] -- SLEAP version [e.g v1.2.3] -- SLEAP installation method [e.g conda, pip] - -## Screenshots - -* Please share any relevant screenshots of the issue - -## Terminal Output - -* Please share the applicable error logs -* Optional: share output from `sleap-diagnostic` - -## Steps to Reproduce - -* If applicable, please provide detailed steps for reproducing the issue. From 67cfdf726977aa28a864e1c38b1da43b23fd3800 Mon Sep 17 00:00:00 2001 From: sheridana Date: Mon, 23 May 2022 18:37:01 -0700 Subject: [PATCH 12/14] Update CONTRIBUTING.md --- docs/CONTRIBUTING.md | 55 ++++++++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e031e0744..6b072ac42 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -21,42 +21,43 @@ Github has made it easy to separate issues from discussions. Generally speaking, ### Issues -* Check [open/closed issues](https://github.com/talmolab/sleap/issues), [discussions](https://github.com/talmolab/sleap/discussions), and [sleap.ai help page](https://sleap.ai/help.html) to make sure issue doesn't already exist / has been solved -* Create new issue using the [issue template](https://github.com/talmolab/sleap/blob/arlo/contributing_guide/docs/ISSUE_TEMPLATE.md) +* Check [open/closed issues](https://github.com/talmolab/sleap/issues), [ideas](https://github.com/talmolab/sleap/discussions/categories/ideas), and [the help page](https://github.com/talmolab/sleap/discussions/categories/help) to make sure issue doesn't already exist / has been solved. +* Create new issue using the [issue template](https://github.com/talmolab/sleap/blob/arlo/contributing_guide/.github/ISSUE_TEMPLATE/bug_report.md). ### Discussions -* This is a place to go to ask questions and propose new ideas -* 3 categories: general, help, ideas - * **Help** - having trouble with software, user experience issue, etc - * **Ideas** - enhancements, things that would make the user experience nicer but not necessarily a problem with the code - * **General** - if it doesn't fall into help/ideas it goes here as long as it isn't bug fix (issue) +* This is a place to go to ask questions and propose new ideas. +* 3 categories: Help, Ideas, General + * **Help** - Having trouble with software, user experience issue, etc. + * **Ideas** - Enhancements, things that would make the user experience nicer but not necessarily a problem with the code. + * **General** - If it doesn't fall into help/ideas it goes here as long as it isn't bug fix (issue). ### Pull Requests -1) install source code [develop branch](https://sleap.ai/installation.html#conda-from-source) and follow instructions to create conda env etc -2) create fork - * either work on develop branch in own fork or can create branch on either github or cli - * if creating a branch, use your name followed by a relevant keyword for your changes, eg: `git checkout -b john/some_issue` -3) make some changes to source code or additions that tackle the issue(s) -4) write [tests](https://github.com/talmolab/sleap/tree/develop/tests) - * can either write before pr or submit draft pr and then write tests to narrow down error prone lines - * the test(s) should go into relevant subtest folders to the proposed change(s) - * test(s) should aim to hit every point in the proposed change(s) - cover edge cases to best of your ability - * try to hit code coverage points -5) add files and commit (make sure to correct branch!) -6) create Draft PR (on github - follow instructions in template) - * make sure tests pass and code coverage is good - * if tests fail, repeat steps 4-7 -7) once draft pr looks good, submit a PR (hit `ready for review` button) - * optionally assign a reviewer on right of screen -8) if reviewer requests changes, repeat steps 4-8 -9) once reviewer signs off they will squash + merge +1) Install source code [develop branch](https://sleap.ai/installation.html#conda-from-source) and follow instructions to create conda env, etc. +2) Create fork. + * Either work on develop branch in own fork or can create branch on either github or cli. + * If creating a branch, use your name followed by a relevant keyword for your changes, eg: `git checkout -b john/some_issue` +3) Make some changes to source code or additions that tackle the issue(s). +4) Write [tests](https://github.com/talmolab/sleap/tree/develop/tests). + * Can either write before PR or submit draft PR and then write tests to narrow down error prone lines. + * The test(s) should go into relevant subtest folders to the proposed change(s). + * Test(s) should aim to hit every point in the proposed change(s) - cover edge cases to best of your ability. + * Try to hit code coverage points. +5) Add files and commit (make sure to correct branch!). +6) Create Draft PR (on github - follow instructions in template). + * Make sure tests pass and code coverage is good. + * If tests fail, repeat steps 4-7. +7) Once draft pr looks good, submit a PR (hit `ready for review` button). + * Optionally assign a reviewer on right of screen. +8) If reviewer requests changes, repeat steps 4-8. +9) Once reviewer signs off they will squash + merge. ## Style Guides -* linting - [black](https://black.readthedocs.io/en/stable/) version 21.6b0 (see [dev_requirements](https://github.com/talmolab/sleap/blob/develop/dev_requirements.txt) for any changes) -* coding - generally follow pep8, type hinting is encouraged +* **Linting** - [black](https://black.readthedocs.io/en/stable/) version 21.6b0 (see [dev_requirements](https://github.com/talmolab/sleap/blob/develop/dev_requirements.txt) for any changes). +* **Coding** - generally follow pep8, type hinting is encouraged. +* Use Google style [docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) to document code. #### Thank you for contributing to SLEAP! :heart: From 05f5dbd3087e0c58294aebb08aa3cc53eb4a2700 Mon Sep 17 00:00:00 2001 From: sheridana Date: Mon, 23 May 2022 18:37:58 -0700 Subject: [PATCH 13/14] Remove browser option from bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 35b3cabaa..763113eb1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -23,8 +23,6 @@ Please include information about how you installed. - OS: - - Browser: - - Version(s): - SLEAP installation method (listed [here](https://sleap.ai/installation.html#)): From b113a21c2ab88ba5f61fad69436f285271ef3fbc Mon Sep 17 00:00:00 2001 From: Liezl Maree <38435167+roomrys@users.noreply.github.com> Date: Tue, 24 May 2022 08:57:45 -0700 Subject: [PATCH 14/14] Some changes to wording --- docs/CONTRIBUTING.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 6b072ac42..7d5656476 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to SLEAP -As our community grows it is important to adhere to a set of contribution guidelines. These guidelines may change as needed. Please feel free to propose changes in a pull request! +As our community grows it is important to adhere to a set of contribution guidelines. These guidelines may change as needed. Please feel free to propose changes to source code in a pull request! #### Table Of Contents @@ -13,7 +13,7 @@ As our community grows it is important to adhere to a set of contribution guidel ## Code of Conduct -Everyone contributing to SLEAP is governed by the [SLEAP Code of Conduct](CODE_OF_CONDUCT.md). As such, all are expected to abide by this code. Please report any unacceptable behavior to talmo@salk.edu. +Everyone contributing to SLEAP is governed by the [SLEAP Code of Conduct](CODE_OF_CONDUCT.md). As such, all are expected to abide by this code. Please report any unacceptable behavior to `talmo@salk.edu`. ## Contributing @@ -34,30 +34,32 @@ Github has made it easy to separate issues from discussions. Generally speaking, ### Pull Requests -1) Install source code [develop branch](https://sleap.ai/installation.html#conda-from-source) and follow instructions to create conda env, etc. -2) Create fork. - * Either work on develop branch in own fork or can create branch on either github or cli. +1) Install source code [`develop` branch](https://sleap.ai/installation.html#conda-from-source) and follow instructions to create conda env, etc. +2) Create a fork from the `develop` branch. + * Either work on the `develop` branch or create a new branch (recommended if tackling multiple issues at a time). * If creating a branch, use your name followed by a relevant keyword for your changes, eg: `git checkout -b john/some_issue` -3) Make some changes to source code or additions that tackle the issue(s). +3) Make some changes/additions to the source code that tackle the issue(s). 4) Write [tests](https://github.com/talmolab/sleap/tree/develop/tests). - * Can either write before PR or submit draft PR and then write tests to narrow down error prone lines. + * Can either write tests before creating a draft PR, or submit draft PR (to get code coverage statistics via codecov) and then write tests to narrow down error prone lines. * The test(s) should go into relevant subtest folders to the proposed change(s). * Test(s) should aim to hit every point in the proposed change(s) - cover edge cases to best of your ability. * Try to hit code coverage points. -5) Add files and commit (make sure to correct branch!). -6) Create Draft PR (on github - follow instructions in template). - * Make sure tests pass and code coverage is good. - * If tests fail, repeat steps 4-7. -7) Once draft pr looks good, submit a PR (hit `ready for review` button). - * Optionally assign a reviewer on right of screen. -8) If reviewer requests changes, repeat steps 4-8. -9) Once reviewer signs off they will squash + merge. +5) Add files, commit, and push to origin. +6) Create a draft PR on [Github](https://github.com/talmolab/sleap/pulls) (follow instructions in template). + * Make sure the tests pass and code coverage is good. + * If either the tests or code coverage fail, repeat steps 3-5. +7) Once the draft PR looks good, convert to a finalized PR (hit the `ready for review` button). + * IMPORTANT: Only convert to a finalized PR when you believe your changes are ready to be merged. + * Optionally assign a reviewer on the right of the screen - otherwise a member of the SLEAP developer team will self-assign themselves. +8) If the reviewer requests changes, repeat steps 3-5 and `Re-request review`. +9) Once the reviewer signs off they will squash + merge the PR into the `develop` branch. + * New feautures will be available on the `main` branch when a new release of SLEAP is released. ## Style Guides -* **Linting** - [black](https://black.readthedocs.io/en/stable/) version 21.6b0 (see [dev_requirements](https://github.com/talmolab/sleap/blob/develop/dev_requirements.txt) for any changes). -* **Coding** - generally follow pep8, type hinting is encouraged. -* Use Google style [docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) to document code. +* **Lint** - [Black](https://black.readthedocs.io/en/stable/) version 21.6b0 (see [dev_requirements](https://github.com/talmolab/sleap/blob/develop/dev_requirements.txt) for any changes). +* **Code** - Generally follow [PEP8](https://peps.python.org/pep-0008/). Type hinting is encouraged. +* **Documentation** - Use [Google-style comments and docstrings]([https://google.github.io/styleguide/pyguide.html](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)) to document code. #### Thank you for contributing to SLEAP! :heart: