Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.54 KB
Raw

How to contribute

We welcome all contributions to MDAnalysis TUI!

Contributions can take many forms, such as:

  • sharing bug reports or feature requests through the Issue Tracker
  • asking or answering questions, or otherwise joining in on discussions
  • adding bug fixes, new features, or otherwise improving the code
  • adding or improving documentation

The second two options both involve making a pull request .

There are many existing guides on how to make a contribution to an open source project on GitHub. In short, the steps are to:

  • Ensure that you have a GitHub account
  • Fork the repository into your own account
  • On your local machine, clone your fork
  • Create a development environment from source, following the Installation from source instructions
  • Create a new branch off the main branch with a meaningful name (e.g. git checkout -b fix-issue-39)
  • Add your modifications to the code or documentation
  • Add tests if modifying the code
  • Commit and push changes to GitHub, and open a pull request

Guides such as the MDAnalysis User Guide have been written in much more detail to go through these steps more thoroughly. We strongly encourage you to check those for help, and we welcome any questions. Thank you for your contribution!