Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

50 lines (29 loc) · 2.11 KB
Raw

Contributing to Typed Environment Loader

Thank you for considering contributing to the Typed Environment Loader! This guide outlines how you can contribute to this project.

How to Contribute

Reporting Bugs

If you encounter a bug while using the Typed Environment Loader, please open an issue on GitHub and provide as much detail as possible. Include steps to reproduce the bug and any relevant information about your environment.

Suggesting Enhancements

You can suggest enhancements or new features by creating an issue on GitHub. Describe the enhancement you would like to see and explain why it would be beneficial.

Pull Requests

We welcome pull requests from contributors! Before submitting a pull request, please follow these guidelines:

  1. Fork the repository and create a new branch for your changes.
  2. Ensure your code adheres to the project's coding style and conventions.
  3. Write clear and concise commit messages.
  4. Include tests for any new functionality or fixes you introduce.
  5. Update documentation as necessary to reflect your changes.

Development Setup

To set up a development environment for the Typed Environment Loader, follow these steps:

  1. Clone the repository: git clone https://github.com/ahmedheltaher/typed-environment-loader.git
  2. Install dependencies: npm install

Running Tests

You can run tests using the following command:

npm test

Submitting Changes

Once you've made your changes and they pass the tests, you can submit a pull request. Be sure to include a detailed description of your changes and reference any relevant issues.

Code of Conduct

Please note that this project is governed by the Contributor Covenant Code of Conduct. By participating in this project, you agree to abide by its terms.

Please remember to adhere to the Code of Conduct in all interactions related to this project.

Thank you for contributing to the Typed Environment Loader! Your help is greatly appreciated.