Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trigger checks #431

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

trigger checks #431

wants to merge 1 commit into from

Conversation

Marcello-Sega
Copy link
Owner

Please make sure that your pull request satisfies the following requirements:

If you have fixed a bug

  • Explain the fix in the pull request, and add a minimal code that reproduces the bug & the fix
  • Add the minimal code to the docstring tests if possible

If you have written a new method in one of the available modules

  • Document it with a docstring
  • Add a short, deterministic test in the docstring
  • Explain briefly what the patch is about in the pull request

"Big" Pull requests

  • Submit one commit per issue/change if possible.
  • There can be many commits in a pull request, but please try to group them thematically (e.g., avoid git commit -a)
  • In case you have many small commits, you can always rebase them in your tree before submitting the pull request.
  • Pull requests that include merge commits won't be in general accepted
  • If you make a pull request from your master branch, you do it at your own risk (see also the point above)

If you have implemented a new module

  • All main methods should be documented
  • Tests should be added to the docstrings
  • The module works with as many different input file formats as possible
  • Interfacial atoms (if calculated) are marked as such, similarly to the other modules
  • The module does not change the configuration (positions, velocities,...) as loaded by MDAnalysis
  • __init__() calls pytim.PatchTrajectory
  • you have prepared a section to be added to the online manual
  • you have prepared one or more sample jupyter notebooks
  • you have added one or more minimal example python scripts to be added to pytim/examples/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant