Thank you for considering contributions to the Retail Inventory Management System. Your support helps to enhance and maintain the project as a robust tool for inventory management.
- Before submitting an issue, check that it has not already been reported.
- Provide a clear and detailed description, including steps to reproduce the issue, expected outcomes, and actual outcomes.
- Fork the repository and create your branch from
master. - Follow the coding style and conventions present in the codebase.
- If you've added code, add corresponding tests.
- Ensure all tests are passing.
- Update the documentation to reflect your changes, if applicable.
- Submit a detailed pull request explaining your changes.
- Use 4 spaces for indentation rather than tabs.
- Adhere to the naming conventions and coding styles that are already established.
- Comment your code to explain complex logic.
Ensure to run any existing tests to confirm that your changes have not introduced new issues. Instructions for running tests should be in the project's README.
I will review all contributions. The goal is to check new pull requests within a week. If the pull request is acceptable and all tests pass, I will merge it.
Your contribution is important, and I look forward to collaborating with you to improve the Retail Inventory Management System!