Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.98 KB

Contributing Guidelines

Thank you for considering contributing to this project! We welcome any and all contributions, whether they be bug reports, feature requests, documentation improvements, or code contributions.

Getting Started

To contribute to this project, you will need:

  • A working installation of Rust and Cargo. You can install Rust from the official website: https://www.rust-lang.org/tools/install
  • A clone of the project's repository: git clone git@github.com:tdmckenney0/hwrm-scaffold.git
  • A working installation of Sqlite3.

Code Contributions

If you'd like to contribute code to this project, please follow these guidelines:

  1. Fork the repository and create a new branch for your changes: git checkout -b my-feature-branch
  2. Make your changes and ensure they pass the tests by running cargo test
  3. Commit your changes with a clear and concise commit message that explains what you did: git commit -m "Add feature X"
  4. Push your changes to your fork: git push origin my-feature-branch
  5. Open a pull request against the main repository.

Please ensure that your code follows the project's coding conventions and style guidelines. In addition, please make sure that any new or modified code is well-documented.

Bug Reports and Feature Requests

If you encounter a bug or have a feature request, please open an issue on the project's issue tracker. Please provide as much detail as possible, including:

  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Any error messages or stack traces

Documentation Contributions

If you'd like to contribute to the project's documentation, please follow these guidelines:

  1. Fork the repository and create a new branch for your changes: git checkout -b my-docs-branch
  2. Make your changes and ensure they pass the tests by running cargo test
  3. Commit your changes with a clear and concise commit message that explains what you did: git commit -m "Update documentation for feature X"
  4. Push your changes to your fork: git push origin my-docs-branch
  5. Open a pull request against the main repository.

Please ensure that your documentation follows the project's style guidelines. In addition, please make sure that any new or modified documentation is accurate and helpful.

Database Contributions

If you'd like to contribute to the project's database schema or data, please follow these guidelines:

  1. Fork the repository and create a new branch for your changes: git checkout -b my-db-branch
  2. Make your changes and ensure they pass the tests by running cargo test
  3. Commit your changes with a clear and concise commit message that explains what you did: git commit -m "Update database schema for feature X"
  4. Push your changes to your fork: git push origin my-db-branch
  5. Open a pull request against the main repository.

Please ensure that your database changes follow the project's conventions and style guidelines. In addition, please make sure that any new or modified database schema or data is well-documented.