Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.62 KB
Raw

Contributing to [StocksALot]

Thank you for your interest in contributing to this project! Here are some guidelines to help you get started.

Issues

If you encounter a bug or have a feature request, please use the appropriate issue template to submit an issue.

Pull Requests

Ways to contribute

Here are some ways in which you can contribute, in ascending order of preference:

  • Report a bug
  • Fix an existing bug
  • Improve test coverage
  • Improve documentation
  • Enhance Frontend
  • Add new features
  • Refactor code

If you would like to contribute code to this project, please follow these steps:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Test your changes
  5. Submit a pull request (please make sure to use the pull request template)
  6. Wait for your pull request to be reviewed
  7. Make any requested changes
  8. Wait for your pull request to be merged
  9. Celebrate!

Code Style

Please follow the existing code style in this project. If you're not sure what that is, take a look at the existing code and try to match it. Run the Pylint and Eslint linters to ensure that your code follows the style guidelines.

Testing

Please make sure your code is thoroughly tested before submitting a pull request. We use unit tests to ensure that the code works as expected.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

This project is licensed under the BSD-3-Clause license. By contributing to this project, you agree to the terms and conditions of this license.