Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (36 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

43 lines (36 loc) · 2.03 KB

Contributing to TunnelForge

We welcome contributions to TunnelForge! Whether you're fixing bugs, adding new features, or improving documentation, your help is appreciated. Please read through the guidelines below to make the process smooth and effective.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to [elshadaghazade@gmail.com].

How to Contribute

  1. Report Bugs: Use the GitHub Issues to report bugs.
  2. Suggest Features: Open an issue for feature requests and improvements.
  3. Fix Bugs or Add Features: Follow the Development Workflow and submit a Pull Request.
  4. Improve Documentation: Fix typos, add examples, or improve clarity.

Development Workflow

Working on Issues

  1. Choose an issue: Look at the issues list for tasks marked as help wanted or good first issue.
  2. Create a branch: Use a descriptive name for your branch. 
    git checkout -b feature/your-feature-name
  3. Write code: Follow the project's coding style and ensure your changes work as expected.
  4. Run tests: 
    npm test

Commit Messages

Use clear and concise commit messages following the Conventional Commits standard. Example:

  • feat: add support for feature X
  • fix: resolve bug in Y module
  • docs: improve API documentation

Pull Requests

  1. Submit a PR: Push your changes to your fork and create a Pull Request on the main repository.
  2. Follow guidelines:
    • Reference the issue you’re solving.
    • Provide a description of your changes.
  3. Code Review: Be responsive to feedback from maintainers.

Resources