ts-utils
  • Getting Started
  • Contributing
  • Testing
  • Functions
    • Array Methods
      • isArr
      • isArrEmpty
      • pushUniqueValue
      • pushOrUpdate
    • Date Methods
      • toNow
      • formatDate
      • fromNow
    • Number Methods
      • toFixed
      • parseNumber
      • parseFormat
      • addUnit
      • addSeparators
      • formatNumber
      • ensureNumber
      • numberEmptyState
    • Object Methods
      • parseJSON
      • deepClone
      • parseNumValues
      • removeEmptyKeys
      • sanitizeQuery
      • removeKeys
      • renameKey
      • renameKeys
      • sortByKeyLength
      • querylize
      • parseNumericObj
      • reserveKeys
      • hasKeysAndValues
    • String Methods
      • randomStr
      • toUpperCase
      • toLowerCase
      • toFullUrl
      • initials
      • generateUuid
Powered by GitBook
On this page
  • Table of Contents
  • How to Contribute
  • Contribution Guidelines

Was this helpful?

Contributing

PreviousGetting StartedNextTesting

Last updated 11 months ago

Was this helpful?

Table of Contents

How to Contribute

We welcome and appreciate contributions to the Check-Engineering/TS-Utils package. Your input is valuable to us, and we eagerly anticipate your contributions. If you encounter any issues or have suggestions for enhancements, please feel free to contribute. These are a few areas where you can contribute to:

  • Core functionalities such as performance improvements, bug fixes, new features, etc.

  • Documentation

  • Test suite and development of environment improvements.

If you encounter an issue and you do not have the time, or experience to work with the library, don't hesitate to .

Contribution Guidelines

As this package is sensitive in nature, we kindly request that you adhere to the guidelines and maintain the existing code structure when making contributions. This ensures consistency and helps us uphold the quality and integrity of the package.

To contribute, please follow these steps:

  1. Familiarize yourself with the project's purpose and existing code structure.

  2. Fork the repository to create a local copy.

  3. Create a new branch for your contribution, including a descriptive name and reference to the issue or enhancement.

  4. Write clear and concise code that follows the existing coding style.

  5. Thoroughly test your changes to ensure they do not break existing functionality.

  6. Submit your changes as a pull request to the main repository, including a detailed description of the changes and how they address the issue or enhancement.

  7. Respond to feedback by engaging with the project maintainers and other contributors.

Important: Before pushing your final code, make sure to run the build command to generate an updated README file.

By following these steps and ensuring the README is up to date, you can help ensure that your contributions are well-received and effectively integrated into the project.

open a new issue
How to Contribute
Contribution Guidelines