Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 2.96 KB
Raw

Contributing Guidelines

Thank you for considering contributing to Linkspector! We welcome contributions from the community to help improve and grow this tool. Please take a moment to review these guidelines to ensure a smooth and collaborative contribution process.

Table of Contents

  1. Getting Started
  2. Code of Conduct
  3. How to Contribute
  4. Development Setup
  5. Testing
  6. Commit Messages
  7. License

Getting Started

Before you start contributing, please make sure you have:

  • Familiarized yourself with the project's goals and objectives.
  • Read and understood the project's license (See License).
  • Set up a GitHub account if you don't already have one.

Code of Conduct

Please review and adhere to our Code of Conduct to ensure a respectful and inclusive environment for all contributors and users.

How to Contribute

Reporting Issues

If you encounter a bug, have a feature request, or have any questions about the project, please open an issue on the GitHub Issues page. Be sure to provide as much detail as possible, including the steps to reproduce the issue and any relevant error messages or screenshots.

Submitting Pull Requests

We welcome contributions in the form of pull requests (PRs). To submit a PR, follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch from the main branch for your changes.
  3. Make your changes and commit them with clear and concise messages (see Commit Messages).
  4. Push your branch to your forked repository.
  5. Create a pull request from your branch to the main branch of this repository.

Our maintainers will review your PR as soon as possible and provide feedback if needed. Once your PR is approved, it will be merged into the project.

Development Setup

To set up a development environment, follow the instructions in the Development Setup document. This will guide you through the process of installing dependencies and configuring your development environment.

Testing

Before submitting a pull request, make sure to run the test suite to ensure that your changes do not introduce any regressions. To run the tests, use the following command:

npm test

Commit Messages

Follow these guidelines for commit messages:

  • Use clear and concise messages that explain the purpose of the commit.
  • Start the message with a verb in the present tense (e.g., "Add feature," "Fix bug").
  • Reference related issues or pull requests by including their numbers (e.g., "Fixes #123," "Closes #456").

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.