Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

76 lines (46 loc) · 3.51 KB

Contributing to E-Commerce Web Application

First off, thank you for considering contributing to our E-Commerce Web Application. It's people like you that make the open source community such a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

How Can I Contribute?

There are many ways you can contribute to our project, such as:

  • Reporting bugs
  • Suggesting enhancements
  • Writing code which can be incorporated into the project
  • Improving documentation

Reporting Bugs

This section guides you through submitting a bug report for the E-Commerce Web Application. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report

  • 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

This section guides you through submitting an enhancement suggestion for the E-Commerce Web Application, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion

  • Check if the enhancement has already been suggested or implemented by searching under Issues and Pull Requests.
  • When you are creating an enhancement suggestion, please include as many details as possible, including the step-by-step actions which should be taken if the enhancement is implemented and why this would be beneficial to most E-Commerce Web Application users.

Code Contribution

Pull Requests

The process described here has several goals:

  • Maintain the project's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible E-Commerce Web Application
  • Enable a sustainable system for the project's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Python Styleguide

  • Use PEP 8 as the primary coding standard.
  • Include comments in your code where necessary.

Documentation Styleguide

  • Use Markdown for documentation.
  • Keep the language simple and concise.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Questions or Concerns?

If you have any questions or concerns about contributing, please open an issue in the repository or contact the project maintainers.

Again, thanks for your interest in contributing to the E-Commerce Web Application. We look forward to your contributions!