Contributing to invoice-builder

January 5, 2026 ยท View on GitHub

Thank you for considering contributing to invoice-builder! We appreciate the time and effort you dedicate to helping this project grow.

Code of Conduct

This project adheres to the CODE-OF-CONDUCT.

Getting Started

  1. Fork the repository and clone it to your local machine.
  2. Install project dependencies: npm install
  3. Run tests to ensure everything is set up correctly: npm test

Issues and Feature Requests

If you encounter a bug or have a feature request, please create an issue following the template provided.

Bug Report

Description

Provide a concise description of the bug.

Steps to Reproduce

  1. Step 1 to reproduce the bug
  2. Step 2 to reproduce the bug
  3. Additional steps if needed

Expected Behavior

Describe what you expected to happen.

Actual Behavior

Describe what actually happened.

Screenshots

If applicable, add screenshots to help explain the problem.

Additional Information

Include any additional information or context about the bug.

Feature Request

Description

Provide a concise description of the feature request.

Motivation

Why do you want this feature? What use case does it address?

Proposed Solution

If you have a potential solution in mind, describe it here.

Alternatives Considered

Have you considered any alternative solutions or features?

Additional Information

Include any additional information or context about the feature request.

Branching Strategy

  • main: Main development branch.
  • feature/{tickent number}-{branch name}: Use feature branches for developing new features.
  • bugfix/{tickent number}-{branch name}: Use bugfix branches for fixing bugs.

Pull Requests

  1. Fork the repository and create a new branch based on the branching strategy.
  2. Make your changes and ensure that all tests pass.
  3. Submit a pull request with a clear title and description of the changes.

Code Style

General Guidelines

  • Use 2 spaces for indentation.
  • Always use meaningful variable and function names.
  • Follow a consistent naming convention for variables and functions (e.g., camelCase).
  • Use single quotes for strings unless interpolation is needed.

TypeScript Specific Guidelines

  • Take advantage of TypeScript's static typing to enhance code robustness.
  • Use TypeScript interfaces for defining data shapes.

Linting

We use ESLint to enforce our coding standards. You can run the linter locally by using the following command:

npm run lint
npm run format

Review Process

  1. Pull requests will be reviewed within [5 days].
  2. Feedback and possible adjustments may be requested during the review process.
  3. Once approved, changes will be merged into the main branch.

License

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

Conclusion

Thank you for contributing to invoice-builder! Your time and efforts are greatly appreciated.

Feedback

We welcome your feedback on these contribution guidelines. Feel free to open an issue to suggest improvements.