Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 2.98 KB
Raw

Contributing to Node Projects

Thank you for considering contributing to Node Projects! We welcome contributions from the community to help improve and grow this project. Please take a moment to read this document to understand how you can contribute.

Table of Contents

Code of Conduct

Before contributing, please review our Code of Conduct. All contributors are expected to adhere to it to maintain a respectful and inclusive community.

How Can I Contribute?

Reporting Bugs

If you come across a bug or unexpected behavior, please help us by reporting it. To ensure that your report is effective, please include the following details:

  • A clear and descriptive title.
  • A detailed description of the issue, including what you expected to happen and what actually happened.
  • Steps to reproduce the issue if possible.
  • Any relevant error messages or screenshots.

Suggesting Enhancements

For suggestions or feature requests, please create a new issue using the feature request template. Provide as much context as you can to help us understand the need for the enhancement.

Working on Issues

If you'd like to contribute by working on existing issues, feel free to browse our issue tracker. Issues that are labeled as "help wanted" or "good first issue" are suitable for newcomers. Please follow our code of conduct and guidelines for working on issues.

Submitting Pull Requests

We welcome contributions in the form of pull requests (PRs). Here's the process to follow:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your changes from the main branch.
  3. Make your changes, following the coding guidelines.
  4. Write tests for your changes if applicable.
  5. Ensure your code passes all tests and lint checks.
  6. Submit a pull request to the main branch of this repository.

Development Setup

To set up a development environment, please follow the instructions in our development setup guide.

Coding Guidelines

Please adhere to our coding guidelines when writing code for this project. Consistent code style and quality are important to maintain.

Testing

We encourage writing tests for new features and bug fixes. You can run tests using the following command:

npm test