Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.32 KB

Reporting Issues

If you encounter any bugs, issues, or have feature requests, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots.

Submitting Pull Requests

  1. Ensure your branch is up to date with the main repository's main branch. 
    git fetch upstream
git checkout main
git merge upstream/main
  2. Follow the Coding Standards and ensure your code passes all tests.
  3. Create a detailed pull request description, including the purpose of the changes and any relevant information.
  4. Link any related issues in the pull request description.
  5. Wait for a project maintainer to review your pull request. Be prepared to make any requested changes.

Coding Standards

  • Follow the existing code style and conventions.
  • Write clear, concise, and well-documented code.
  • Use meaningful variable and function names.
  • Ensure your code is properly formatted.

Documentation

  • Update the README.md file if your changes affect the usage or setup of the project.
  • Add or update comments in the code to explain complex logic or important sections.
  • Ensure any new features or changes are documented in the appropriate markdown files.