Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

98 lines (72 loc) · 3.78 KB
Raw

Contributing to Link Checker

First off, thank you for considering contributing to Link Checker! It's people like you that make this project possible. We welcome any kind of contribution, whether it's reporting issues, submitting enhancements, or improving documentation.

How to Contribute

Reporting Issue

If you encounter any issues or bugs while using Link Checker, please report them by opening an issue on the GitHub issues page. When reporting an issue, please include:

  • A clear and descriptive title.
  • A detailed description of the problem, including steps to reproduce the issue.
  • Any error messages or logs.
  • Your operating system and version.

Suggesting Enhancements

If you have ideas to improve Link Checker, we'd love to hear them! You can suggest enhancements by opening an issue on the GitHub issues page. When suggesting an enhancement, please include:

  • A clear and descriptive title.
  • A detailed description of the enhancement.
  • Any relevant examples or screenshots.

Pull Requests

  1. Fork the repository on Github.
  2. Clone your fork to your local machine:
git clone https://github.com/KaganCanSit/LinkChecker.git
cd LinkChecker
  1. Create new branch for your changes:
git checkout -b feature-branch
  1. Make your changes to the code.
  2. Test your changes thoroughly to ensure they work as expected.
  3. Commit your changes:
git commit -m "Description of the changes"
  1. Push your changes to your fork:
git push origin feature-branch
  1. Create a pull request to the main repository. Please include a detailed description of your changes and any relevant issue numbers.

Code Style and Standards

To maintain consistency and quality in the codebase, please follow these guidelines:

  • Shell Script Standards: Use ShellCheck to ensure your shell scripts adhere to best practices and avoid common issues:
# Install ShellCheck (if not already installed)
sudo apt-get install shellcheck

# Run ShellCheck on your shell script
shellcheck link_checker.sh

ShellCheck will analyze your link_checker.sh script for syntax errors, style inconsistencies, and common pitfalls in shell scripting.

  • General scrip test must pass: Ensure that your scripts pass general tests by running them against various test cases. It is also recommended to validate your script tests:
# Update package list and install Bats (if not already installed)
sudo apt-get install -y bats

# Navigate to your LinkChecker directory
cd /LinkChecker

# Run Bats tests located in the tests/ directory
bats tests/

This sequence of commands installs Bats (the Bash Automated Testing System) and executes all test cases defined in the tests/ directory of your LinkChecker project. This ensures that your scripts behave as expected across different scenarios.

  • Comments: Add comments to your code where necessary to explain functionality.
  • Readability: Write clear and readable code. Avoid complex and nested logic when possible.

Testing

Before submitting your pull request, make sure to:

  • Test your changes thoroughly.
  • Run the script to ensure there are no errors.
  • Check for regressions to avoid breaking existing functionality.

Documentation

Help us improve the documentation:

  • Update the README.md if you make changes to the user interface or functionality.
  • Ensure the CONTRIBUTING.md is up to date with your changes.

Getting Help

If you need help or have questions, contact the maintainers.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Thank you for your contributions!