Add contributors guide #112
Open
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
schmoelder
force-pushed
the
dev
branch
4 times, most recently
from
f778466 to
0534130
Compare
schmoelder
force-pushed
the
contributors_guide
branch
from
72f0aaf to
e1d7d85
Compare
schmoelder
force-pushed
the
dev
branch
8 times, most recently
from
9478b91 to
841f188
Compare
schmoelder
force-pushed
the
contributors_guide
branch
from
e1d7d85 to
61d7587
Compare
schmoelder
force-pushed
the
dev
branch
2 times, most recently
from
d10f69b to
cd4c8ee
Compare
schmoelder
force-pushed
the
contributors_guide
branch
from
61d7587 to
760214f
Compare
Previously, there were two interfaces in the `OptimizationProblem` for calling evaluation functions (e.g. objectives): one for evaluating individuals, and one for populations. To simplify the code base, these two methods were now unified. To ensure backward compatibility, a 1D-Array is returned if a single individual is passed to the function.
Co-authored-by: r.jaepel <[email protected]>
Previously, the cadet path set in Cadet(install_path="path") was not inherited into cadet instances created from the run() method.
Fix and extend tests about .calculate_interstitial_rt/velocity
schmoelder
force-pushed
the
contributors_guide
branch
from
760214f to
94743bd
Compare
schmoelder
commented
Jun 19, 2024
| Thanks for your interest in contributing to **CADET-Process**! | ||
| To streamline the development, please carefully read the following guide. | ||
|
|
||
| # How to contribute |
There was a problem hiding this comment.
Watch header level
|
|
||
| For further guidance about getting started, please refer to the related links: | ||
|
|
||
| * [Pull Request Guidelines](PULL_REQUEST_TEMPLATE.md) |
There was a problem hiding this comment.
We should also add templates for CADET-Process (see cadet/CADET-Core#207)
|
|
||
| ## Coding conventions | ||
|
|
||
| > Code should be optimized for readability. Attach some custom style guide or reference some. i.e.: |
There was a problem hiding this comment.
Update for Python.
|
|
||
| In order to sanitize coding standards, please follow [this style guide](https://github.com/airbnb/javascript). | ||
|
|
||
| ## Code of Conduct |
There was a problem hiding this comment.
Do we really need this?
|
|
||
| > This section should explicitly state that we will not discriminate against people on any grounds other than their code contributions, and make clear that behaviour that would be harmful to other people that may wish to contribute is not acceptable. This gives clear authority to remove people who are causing problems, and also sets a clear tone of inclusion. | ||
|
|
||
| > **ProTip:** You can find more about [Contributor Covenant](http://contributor-covenant.org) or as a seperate `code_of_conduct` file. [Good sample](http://contributor-covenant.org/version/1/4/). |
There was a problem hiding this comment.
Add information about CLA!
|
|
||
| ## I would like to join this list. How can I help the project? | ||
|
|
||
| For more information, please refer to our [CONTRIBUTING](CONTRIBUTING) guide. |
schmoelder
force-pushed
the
dev
branch
11 times, most recently
from
35e0c67 to
d97cf31
Compare
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.
This PR adds a contributor's guide to CADET-Process.
To do
pip install -e .)black/ruff/pre-commit)fix/...,feature/...)References
Here are some references to get inspiration: