add developer guide #268
Open
add developer guide #268
Conversation
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
jalew188
reviewed
Jan 8, 2025
jalew188
approved these changes
Jan 8, 2025
mschwoer
approved these changes
Jan 9, 2025
| Avoid making assumptions about: | ||
| - Precursor ordering by `nAA` | ||
| - Fragment indices ordering (e.g., `frag_start_idx`) | ||
| - Continuity of `frag_start_idx` where `frag_start_idx[i+1] = frag_stop_idx[i]` |
There was a problem hiding this comment.
(nit) - Continuity of frag_start_idx, i.e. frag_start_idx[i+1] == frag_stop_idx[i]
|
|
||
| #### 4. Code Quality | ||
| - Include type hints for all functions (see [numpy docstring example](https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html#example-numpy)) | ||
| - Include python type hints |
There was a problem hiding this comment.
what do you mean exactly here?
| [alphashared](https://github.com/MannLabs/alphashared) repository. Please see the instructions | ||
| [there](https://github.com/MannLabs/alphashared/blob/reusable-release-workflow/.github/workflows/README.md#release-a-new-version). | ||
|
|
||
|
|
||
| ------------------------------------------------------------------------ | ||
|
|
||
| ## Changelog |
There was a problem hiding this comment.
as you are already on that: ```
For a full overview of the changes made in each version see CHANGELOG.md (until version 1.1.0) and the github release notes (from >1.1.0).
|
|
||
| #### pre-commit hooks | ||
| #### 1. Code Structure | ||
| While AlphaBase offers an object-oriented interface, implement algorithms for manipulating data in a functional way and call them from class methods. |
There was a problem hiding this comment.
.. to be able to reuse them without instantiating a class.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi all,
I think there are some patterns in AlphaBase which have been introduced by Feng and evolved with me and Magnus joining. I think we should formalize them a bit with more developers joining.
This is just a first version and most likely not comprehensive.