Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (18 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.51 KB

Contributing to Stochastix

First off, thank you for considering contributing to Stochastix! It's people like you that make open source such a great community.

How Can I Contribute?

Reporting Bugs

If you find a bug, please ensure the bug was not already reported by searching on GitHub under Issues.

If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. Create an issue on that repository and describe the enhancement you would like to see, why it would be useful, and any implementation ideas you may have.

Pull Request Process

  1. Fork the repository and create your branch from master.
  2. If you've added code that should be tested, add new tests.
  3. Issue that pull request!

Coding Standards

This project doesn't enforce coding standards yet. However, here are some general guidelines to follow:

  • use only the composition API syntax in components or pinia stores
  • use script setup syntax in components
  • the template tag should be the first tag in a component, followed by the script tag
  • use PascalCase for component names and filenames