Skip to content

Contributing Guide

Illia Kotvitskyi edited this page Sep 8, 2024 · 2 revisions

Contributing to Trendlink

We welcome contributions to Trendlink! Please follow the guidelines below to help us maintain a smooth process.

Getting Started

  1. Fork the repository: Create your own copy by forking Trendlink.
  2. Create a feature branch:
    git checkout -b feature/your-feature-name
  3. Commit your changes: Write clear, descriptive commit messages.
    git commit -m 'Add: Description of the feature'
  4. Push to your branch:
    git push origin feature/your-feature-name
  5. Open a Pull Request (PR): Submit your PR with a clear description of the changes made and link to relevant issues.

Code Guidelines

  • Follow coding standards: Adhere to project coding conventions.
  • Write tests: Ensure new features and bug fixes are covered with unit/integration tests.
  • Document your changes: Update relevant documentation (e.g., README, Wiki) if necessary.
  • Stay up-to-date: Sync with the latest main branch before submitting your PR.
    git pull origin main

Pull Request Process

  1. Ensure all existing and new tests pass.
  2. Provide detailed descriptions of the changes in the PR.
  3. Be ready for feedback: Address any comments or requested changes by reviewers.

Reporting Issues

  • Please check the issue tracker before submitting new issues to avoid duplicates.
  • Include as much detail as possible, such as platform, browser, and steps to reproduce the issue.
Clone this wiki locally