Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

15 lines (11 loc) · 1.8 KB
Raw

SCR/VELOC Contributing Guidelines

This software is developed as part of the SCR and VELOC software projects.

This is an open source project. We welcome contributions via pull requests as well as questions, feature requests, or bug reports via issues. Contact our team through GitHub issues, via the SCR mailing lists, or the VELOC mailing list. Please also refer to our code of conduct.

If you aren't an SCR developer at LLNL or VELOC developer as part of ECP, you won't have permission to push new branches to the repository. First, you should create a fork. This will create your copy of this repository and ensure you can push your changes up to GitHub and create PRs. This project uses ECP internal resources via gitlab runners to test code changes. Please include details on how we can test your contribution.

  • Create your branches off the main branch.
  • Clearly name your branches, commits, and PRs as this will help us manage queued work in a timely manner.
  • Articulate your commit messages in the imperative (e.g., Adds new privacy policy link to README).
  • Commit your work in logically organized commits, and group commits together logically in a PR.
  • Title each PR clearly and give it an unambiguous description.
  • Review existing issues before opening a new one. Your issue might already be under development or discussed by others. Feel free to add to any outstanding issue/bug.
  • Be explicit when opening issues and reporting bugs. What behavior are you expecting? What is your justification or use case for the new feature/enhancement? How can the bug be recreated? What are any environment variables to consider?