New contributing guidelines #646
Conversation
ashtonmv
requested review from
jan-janssen,
sudarsan-surendralal,
liamhuber and
samwaseda
Pull Request Test Coverage Report for Build 4780
💛 - Coveralls |
CONTRIBUTING.rst
Outdated
| .. _What should I know before I get started?: | ||
| What should I know before I get started? | ||
| ======================================== | ||
|
|
||
| The structure of pyiron | ||
| ----------------------- | ||
|
|
||
| The principles of pyiron | ||
| ------------------------ | ||
|
|
There was a problem hiding this comment.
I think the structure & principles of pyiron is something that will change drastically in the future based on the discussions we had earlier. For the time being, we could save these lines as a comment and work on it once the new structure is finalized.
There was a problem hiding this comment.
This looks great! Should we also have a markdown version
CONTRIBUTING.mdon github?
I'm happy to also make a markdown version, but it seems the rst file also renders automatically online. Everything else was in rst for the sphinx docs, so that's why I left it that way.
I think the structure & principles of pyiron is something that will change drastically in the future based on the discussions we had earlier. For the time being, we could save these lines as a comment and work on it once the new structure is finalized.
sounds good 👍
CONTRIBUTING.rst
Outdated
| If you don't already have the dependencies installed in your environment, | ||
| ``` | ||
| cd pyiron | ||
| pip install . |
There was a problem hiding this comment.
Wouldn't it be more consistent to install all the packages through conda-forge first and then overwrite the python path to use the your local branch of pyiron?
There was a problem hiding this comment.
Yeah doing it with conda does seem more elegant, but I admit I am sometimes confused by the interaction between conda and $PYTHONPATH.
Maybe conda develop is the way to go? e.g.
conda create --name pyiron_dev
conda activate pyiron_dev
conda install -c conda-forge conda-build pyiron
conda remove --force pyiron # leaves dependencies untouched
conda develop /path/to/git/installed/pyiron # adds git folder to site-packages/conda.pth file| * Limit the first line to 72 characters or less | ||
| * Reference issues and pull requests liberally after the first line | ||
| * When only changing documentation, include [ci skip] in the commit title | ||
| * Consider starting the commit message with an applicable emoji: |
There was a problem hiding this comment.
For pycharm users, you can install the emoji plugin to add emojis for your commit messages: 👨🎨 🐎 🍰
| Python styleguide | ||
| ----------------- | ||
|
|
||
| Please follow `PEP8 conventions`_ for all python code added to pyiron. Pull |
There was a problem hiding this comment.
Maybe IDEs like pycharm could be recommended
There was a problem hiding this comment.
Maybe we should add a section like "Tips and Tricks" where we include this kind of recommendation
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
|
My impression from yesterday was that we can merge this, with more changes likely to come someday. Is that right? |
This is intended as a draft, which hopefully others can also contribute to.
Closes #643, but now that pyiron is public on github and has ~15 contributors, it might be a good time to expand the contributing guidelines. Feel free to remove/replace 100% of what I wrote, since you guys are the core maintainers.
I noticed that @jan-janssen already had some stuff related to this in docs/source/developers.rst, so that's what I've built on. Nearly everything I changed is in CONTRIBUTING.rst, which developers.rst imports from for the online documentation.
To start the discussion, I have a few points/questions: