CONTRIBUTING.md is introduced#17
CONTRIBUTING.md is introduced#17AhmetCanSolak merged 2 commits intonapari:masterfrom AhmetCanSolak:contributing
Conversation
kne42
left a comment
There was a problem hiding this comment.
It looks good but I'd like to see more detailed instructions pertaining to git/GitHub functionality. We should keep in mind that some contributors may not be familiar with git, especially the more complex things like rebasing.
CONTRIBUTING.md
Outdated
|
|
||
| ## Steps to contribute | ||
|
|
||
| - Ensure that your contribution is in its own branch in your fork of the repository (no other changes should be in the branch). |
There was a problem hiding this comment.
Could you include git instructions with this?
CONTRIBUTING.md
Outdated
| - Ensure that your contribution is in its own branch in your fork of the repository (no other changes should be in the branch). | ||
| - Each commit in your branch that you are submitting must have your email address as the 'author'. If you need to configure this specifically for your clone of the repository (because you also work on other projects using git), use git config user.email <address> in that repository clone to set the address for that single clone. | ||
| - Use git rebase to ensure that your contribution applies cleanly to the current HEAD of the master branch in the repository. This also provides a good opportunity to 'squash' any commits in your branch that you'd rather not have live on in infamy! | ||
| - Create a GitHub 'pull request' for your branch, targeted at master. |
more details on git given in CONTRIBUTING.md
|
I updated the commit @kne42 |
CONTRIBUTING.md
Outdated
| ``` | ||
|
|
||
| #### Checkout to your own branch for development | ||
| - Ensure that your contribution is in its own branch in your fork of the repository (no other changes should be in the branch). You can it with: |
| ``` | ||
| git clone https://github.com/<username>/napari-gui # get the repo | ||
| git checkout dev # checkout to dev branch | ||
| git branch <branchname> # create your own branch |
There was a problem hiding this comment.
maybe even just git checkout dev -b <branchname> or is this too confusing?
| ``` | ||
| git checkout BRANCHNAME | ||
| git status | ||
| ``` |
There was a problem hiding this comment.
Maybe include a section about updating the dev branch via git pull upstream dev and the current working branch via git fetch upstream dev; git rebase -Xtheirs upstream/dev (will need to verify I'm not sure if this is right)
added a section on fork and fixed a typo
…visible
The visibilitychanged slot currently updates the title regardless of the visibility. We are seeing a crash when the viewer is shut down and a signal is sent to the visibilitychanged slot. That executes some code which causes a segfault in the python process[1]. This PR changes the visibility changed slot to only update the title bar if the widget is visible.
[1]
```
* frame #0: 0x0000000115cc96e4 QtWidgets`QWidgetPrivate::reparentFocusWidgets(QWidget*) + 356
frame napari#1: 0x0000000115cb99cf QtWidgets`QWidget::setParent(QWidget*, QFlags<Qt::WindowType>) + 911
frame napari#2: 0x0000000115cb82c0 QtWidgets`QWidgetPrivate::init(QWidget*, QFlags<Qt::WindowType>) + 688
frame napari#3: 0x0000000115d73e5e QtWidgets`QFrame::QFrame(QFramePrivate&, QWidget*, QFlags<Qt::WindowType>) + 14
frame napari#4: 0x0000000115dc3705 QtWidgets`QLabel::QLabel(QWidget*, QFlags<Qt::WindowType>) + 277
frame napari#5: 0x0000000116503189 QtWidgets.abi3.so`Sbk_QLabel_Init(_object*, _object*, _object*) + 1497
frame napari#6: 0x000000010015f84d Python`wrap_init + 12
frame napari#7: 0x0000000100113e64 Python`_PyObject_FastCallDict + 143
frame napari#8: 0x00000001001b17a2 Python`call_function + 439
frame napari#9: 0x00000001001aa46b Python`_PyEval_EvalFrameDefault + 3078
frame napari#10: 0x00000001001b1ee2 Python`_PyEval_EvalCodeWithName + 1638
frame napari#11: 0x00000001001b281b Python`_PyFunction_FastCallDict + 447
frame napari#12: 0x0000000100113e99 Python`_PyObject_FastCallDict + 196
frame napari#13: 0x0000000100113fa3 Python`_PyObject_Call_Prepend + 131
frame napari#14: 0x0000000100113d1e Python`PyObject_Call + 101
frame napari#15: 0x000000010015f7d1 Python`slot_tp_init + 57
frame napari#16: 0x000000010015c782 Python`type_call + 178
frame napari#17: 0x0000000100113e64 Python`_PyObject_FastCallDict + 143
frame napari#18: 0x00000001001141fa Python`_PyObject_FastCallKeywords + 97
frame napari#19: 0x00000001001b17a2 Python`call_function + 439
frame napari#20: 0x00000001001aa4fb Python`_PyEval_EvalFrameDefault + 3222
frame napari#21: 0x00000001001b28e0 Python`_PyFunction_FastCall + 110
frame napari#22: 0x0000000100113e99 Python`_PyObject_FastCallDict + 196
frame napari#23: 0x0000000100113fa3 Python`_PyObject_Call_Prepend + 131
frame napari#24: 0x0000000100113d1e Python`PyObject_Call + 101
frame napari#25: 0x000000011126f146 libpyside2.abi3.5.14.dylib`PySide::SignalManager::callPythonMetaMethod(QMetaMethod const&, void**, _object*, bool) + 534
frame napari#26: 0x000000011126eb77 libpyside2.abi3.5.14.dylib`PySide::SignalManager::qt_metacall(QObject*, QMetaObject::Call, int, void**) + 519
```
* Add some notes on shapes layer state. * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Cleanup of notes on Shapes layer. Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com>
* Initial commit * Clean up * Start detailed description * Add some notes on shapes layer state. (#17) * Add some notes on shapes layer state. * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Update docs/naps/4-async-slicing.md Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Cleanup of notes on Shapes layer. Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Vector async slicing nap (#18) * add_vector_info * Apply suggestions from code review Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * add author Co-authored-by: Kim Pevey <kpevey@quansight.com> Co-authored-by: Andy Sweet <andrew.d.sweet@gmail.com> * Some simplification * Update NAP * Revert "Update NAP" This reverts commit e92077c. * Update existing and proposed designs * Add future work and alternatives * Clean up alternatives * Clean formatting. * Pre-PR cleanup * More clean up * Update docs/naps/4-async-slicing.md Co-authored-by: Nicholas Sofroniew <sofroniewn@gmail.com> * Address PR feedback * Update abstract * Clean up abstract * Update motivating video * Signal to event * Add discussion for initial PR Co-authored-by: Eric Perlman <perlman@gmail.com> Co-authored-by: Kim Pevey <kcpevey@quansight.com> Co-authored-by: Kim Pevey <kpevey@quansight.com> Co-authored-by: Nicholas Sofroniew <sofroniewn@gmail.com>
With this PR, I am introducing a contributing guideline. I tried to keep it simple and I am planning to add more as we discussed in an issue possibly. This PR is created to initialize such guide and provoke us to discuss on this matter.