Skip to content

Latest commit

 

History

History
92 lines (58 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

92 lines (58 loc) · 3.12 KB

Contributing to @nodeflip/nest-env-config

Welcome to @nodeflip/nest-env-config! We're excited that you're interested in contributing. This guide outlines how you can get involved and contribute to our project.

Table of Contents

Code of Conduct

We enforce a Code of Conduct in all interactions within our community. Please familiarize yourself with it before participating: Code of Conduct.

Reporting Issues

If you encounter a bug, inconsistency, or have a feature request, please check the issue tracker to see if it has already been reported or discussed. If not, feel free to create a new issue.

Feature Requests

We welcome suggestions for new features or improvements. Please ensure your feature request is clear and provides sufficient context. You can submit your ideas via GitHub Issues.

Contributing Code

Setting Up Your Development Environment

To start contributing to @nodeflip/nest-env-config, follow these steps:

  1. Fork the repository: Click on the "Fork" button on the top right corner of the repository page.

  2. Clone your fork: Clone the repository to your local machine.

    git clone https://github.com/your-username/nest-env-config.git
    cd nest-env-config
  3. Install dependencies: Install the necessary dependencies.

    npm install

Making Changes

  • Create a new branch for your feature or bug fix.

    git checkout -b feature-or-bugfix-name
  • Make your changes, following the code guidelines.

Submitting Pull Requests

  1. Commit your changes:

    git commit -am 'Add new feature or fix issue #123'
  2. Push to your fork:

    git push origin feature-or-bugfix-name
  3. Submit a Pull Request:

    • Go to the Pull Requests tab of the original repository.
    • Click on "New Pull Request".
    • Provide a clear title and description for your pull request, explaining the purpose of your changes.

Code Guidelines

  • Follow TypeScript and NestJS best practices.
  • Maintain consistent coding style and adhere to existing conventions.
  • Write clear commit messages and comments.

Community

Join our community to connect with other contributors and users:

Thank you for contributing to @nodeflip/nest-env-config! Your involvement helps improve our project and supports the community of NestJS developers. We look forward to reviewing your contributions!