Skip to content
Andrew Butler edited this page Apr 26, 2019 · 10 revisions

New to Git or Github? Here is a great resource to start out with.

Issues

We encourage you to submit an issue to our GitHub repository if you have any questions about installing or using Seurat. We're also very grateful to members of the community who help us answer user questions. When posting, here are a few things to consider that can help get an answer quickly:

  • You can search open issues to see if the issue or feature request has already been filed
  • If at all possible, please try to include a reproducible code example so that we can help debug or troubleshoot on our end. See if you can recreate your issue on the pbmc_small dataset that is included with Seurat, or on the datasets we use in our tutorials. You can also include a download link to your own data.
  • Provide the output of sessionInfo(); sometimes issues come up from conflicting packages that were loaded silently or forgotten about.

Pull requests

If you'd like to contribute new features or bug fixes to Seurat, we would welcome a Pull Request (PR) through GitHub! A few things to keep in mind when doing so:

  • You can read about the general procedure for making pull requests at : https://help.github.com/articles/about-pull-requests/
  • PRs should be made with develop as the base branch.
  • To help ensure that new code additions don't conflict with existing functionality, we have 'continuous integration' tests implemented through (Travis CI and AppVeyor). You can read more about how this works here.
  • We've put together a brief list Package conventions section to help maintain a consistent coding style.
  • If adding new functionality, please consider adding a minimal example in the documentation