Invntio Docs
  • Introduction
    • Welcome
  • Getting Started
    • 🚀Quick Start
    • 🏗️Arquitecture
    • 🤓Features
  • Security
    • ✅Validatidation
    • 🛡️XSS Filter
  • Planning
    • 📍Roadmap
    • 📘Changelog
  • API Reference
    • Authentication
    • Endpoints
      • Pets
      • Users
      • Roles
      • Products
      • Categories
      • Warehouses
      • Stocks
      • Transactions
      • Purchase Orders
      • Sale Orders
      • Returns
      • Refunds
      • Customers
      • Bills
      • Receipts
      • Invoices
      • Payments
  • Self-hosting
    • Configuration
    • Database
    • Testing
  • Contributing
    • Guidelines
    • Code of Conduct
  • Learning Resources
    • Basic Learning Resources
  • Support Us
    • Support us
  • External Links
    • GitHub
Powered by GitBook
On this page
  • Overview
  • Issues
  • Contribution Workflow
  • Code Guidelines
  • Licensing
  • Contributor Terms

Was this helpful?

Edit on GitHub
  1. Contributing

Guidelines

How should you contribute?

PreviousTestingNextCode of Conduct

Last updated 2 years ago

Was this helpful?

Overview

Welcome! This project is created by the team at . We're glad you're interested in contributing! We welcome contributions from people of all backgrounds who are interested in making great software with us.

At Inventio, we aspire to empower everyone to create interactive experiences. To do this, we're exploring and pushing the boundaries of new technologies, and sharing our learnings with the open source community.

If you have ideas for collaboration, email us at [email protected].

Issues

Feature Requests

If you have ideas or how to improve the project, you can suggest features by opening a GitHub issue. Make sure to include details about the feature or change, and describe any uses cases it would enable.

Feature requests will be tagged as enhancement and their status will be updated in the comments of the issue.

Bugs

When reporting a bug or unexpected behavior in the project, make sure your issue describes steps to reproduce the behavior, including the platform you were using, what steps you took, and any error messages.

Reproducible bugs will be tagged as bug and their status will be updated in the comments of the issue.

Wontfix

Issues will be closed and tagged as wontfix if we decide that we do not wish to implement it, usually due to being misaligned with the project vision or out of scope. We will comment on the issue with more detailed reasoning.

Contribution Workflow

Open Issues

You can comment on the issue to let others know you're interested in working on it or to ask questions.

Making Changes

  1. Fork the repository.

  2. Create a new feature branch.

  3. Make your changes. Ensure that there are no build errors by running the project with your changes locally.

  4. A maintainer will review your pull request and may ask you to make changes.

Code Guidelines

JavaScript & TypeScript

Angular and NestJS

We follow the coding style guidelines recommended by NestJS and Angular

Licensing

Inventio is licensed under the MIT License. By contributing to this project, you agree to license your contributions under the same license.

Contributor Terms

Thank you for your interest in Inventio open source project. By providing a contribution (new or modified code, other input, feedback or suggestions etc.) you agree to these Contributor Terms.

You confirm that each of your contributions has been created by you and that you are the copyright owner. You also confirm that you have the right to provide the contribution to us and that you do it MIT License.

If you want to contribute something that is not your original creation, you may submit it to Inventio separately from any contribution, including details of its source and of any license or other restriction (such as related patents, trademarks, agreements, etc.).

If you're ready to contribute, start by looking at our open issues tagged as or .

Open a pull request with a name and description of what you did. You can read more about working with pull requests on GitHub .

We use with the default settings to auto-format our JavaScript and TypeScript code.

Please also note that the project is released with a to ensure that they are welcoming places for everyone to contribute. By participating in Inventio open source project, you agree to keep to the Contributor Code of Conduct.

Inventio
help wanted
good first issue
here
Prettier
NestJS coding style guides
Angular coding style guides
Contributor Code of Conduct