Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

18 lines (14 loc) · 1.09 KB

Contributing

We welcome any and all contributions to Lightshow! In particular, we highly encourage incorporating support for a new code. If you wish to contribute, please feel free to do the following:

  1. Create a new GitHub Issue detailing what you would like to do (optional).
  2. Fork your own copy of Lightshow, make your changes and open a Pull Request.
  3. Discuss with the developers and other community members, refining your code as such.
  4. Ensure all tests pass!
  5. Once everyone is satisfied, we will merge your code and make a new release.

Bug reporting

If you find an issue or bug with Lightshow, please report it by opening a a new GitHub Issue detailing the problem. Please make sure your problem is reproducible, and that you document important details such as the package versions you're using (e.g. the version of Lightshow, Pymatgen, etc.) and your operating system.