Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (25 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 1.03 KB

Contributing To Mapping A Website's Internal Links

Thanks for taking the time to contribute.

How To Contribute

  • Report bugs by opening an issue.
  • Suggest enhancements by opening an issue and labeling it as an enhancement.
  • Fork the repo, create a new branch, and submit a pull request.

Branching Strategy

  • Work from a feature branch, not from main.
  • Name your branch using this pattern: feature/your-description or bugfix/short-description.

Before Submitting A Pull Request

  • Ensure the PR description clearly explains the problem and solution.
  • Format your code with Prettier.
  • Update documentation if necessary.

Code Standards

  • Use 2 spaces for indentation.
  • Follow the existing code style.
  • Run Prettier before pushing code.

Running Locally

  1. Clone the repo
  2. Install dependencies
  3. Run python3 app.py

Commit Messages

Follow Conventional Commits.

Code Of Conduct

Please read our Code Of Conduct before contributing.