Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (63 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

80 lines (63 loc) · 2.88 KB

Contributing to Nodejs-ercaspay

Thank you for your interest in contributing to the nodejs-ercaspay package! We welcome contributions of all kinds, including bug fixes, feature additions, and documentation improvements. Please read the guidelines below to help us maintain a collaborative and organized project.

How to Contribute

1. Reporting Issues

If you encounter bugs, errors, or have suggestions for improvements:

  1. Check the issues page to see if the problem has already been reported.
  2. If not, create a new issue with a descriptive title and detailed information, including:
    • Steps to reproduce the issue (if applicable).
    • Your Node.js version and any relevant configurations.
    • Suggestions or expected behavior.

2. Submitting Code Contributions

Prerequisites:

  • Install Node.js (LTS version recommended).
  • Familiarity with Git and basic Node.js development.

Workflow:

  1. Fork the repository to your GitHub account.
  2. Clone your fork to your local machine: 
    git clone https://github.com/your-username/your-repo.git
cd your-repo
  3. Create a new branch for your feature or bug fix: 
    git checkout -b feature-or-bug-name
  4. Make your changes and test them thoroughly.
  5. Commit your changes with a descriptive commit message: 
    git commit -m "Add feature/fix for XYZ"
  6. Push the branch to your fork: 
    git push origin feature-or-bug-name
  7. Create a Pull Request (PR) to the main repository. Include the following in the PR:
    • A clear description of the change.
    • Reference any related issues.
    • Steps for testing your changes (if applicable).

Code Style:

  • Use consistent formatting and indentation.
  • Follow best practices for JavaScript and Node.js development.
  • Run npm run format to fix code styling.

3. Writing Tests

All new features and bug fixes must include test cases to ensure the functionality works as expected and prevent regressions.

  • Use the existing tests folder as a reference.
  • Run tests using npm test to verify all test cases pass.

Guidelines for Documentation Contributions

We value contributions to our documentation! If you notice incomplete or unclear sections in the README.md or other docs:

  1. Fork and edit the documentation files.
  2. Submit a PR with your improvements.

Community and Support

If you need help or have questions, feel free to:

  • Open a GitHub issue with the question label.
  • Join our project discussions in the repository .

Code of Conduct

We strive to maintain a friendly and respectful environment for all contributors. Please adhere to the Code of Conduct while interacting with the community.

Thank You!

Your contributions make this project better for everyone. We appreciate your time and effort. Happy coding! 🎉