Contributing to Dockit

August 14, 2024 ยท View on GitHub

Introduction

First off, thank you for considering contributing to Dockit! It's people like you that make this project great.

How to Contribute

  1. Fork the repository.
  2. Create a new branch (git checkout -b [feat|doc|fix|refactor]/your-branch).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature-branch).
  6. Create a new Pull Request.

Code of Conduct

Please read our Code of Conduct to understand the expectations for behavior when contributing to this project.

Reporting Issues

If you find a bug, please create an issue using the bug report template. Provide as much detail as possible to help us understand and resolve the issue.

Submitting Pull Requests

  • Ensure your code follows the project's coding standards.
  • Write clear, concise commit messages.
  • Include tests for any new functionality.
  • Ensure all tests pass before submitting your pull request.

Coding Standards

  • Follow the typescript style Guide and pass all syle checkes
  • Use Prettier for code formatting.
  • Ensure your code passes linting (npm run lint:check).

Running Tests

  • Run tests with npm test.
  • Ensure all tests pass before submitting your pull request.

Additional Resources