Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 2.18 KB

Contributing to Vincci

We welcome contributions to Vincci! Whether you're a seasoned developer or just starting out, your help is greatly appreciated. Here's how you can contribute:

1. Reporting Issues

  • Find or create an issue: If you encounter a bug or have a feature request, search the existing issues to see if it has already been reported.
  • Provide clear and concise information: When creating a new issue, please provide:
    • A clear and concise description of the issue.
    • Steps to reproduce the issue.
    • The expected behavior.
    • The actual behavior.
    • Your operating system, Node.js version, and any other relevant information.

2. Submitting Pull Requests

  • Fork the repository: Create your own fork of the Vincci repository on GitHub.
  • Create a new branch: Create a new branch for your changes.
  • Make your changes:
    • Follow the existing coding style and conventions.
    • Write clear and concise commit messages.
    • Add tests for your changes.
  • Push to your branch: Push your changes to your forked repository.
  • Create a pull request: Create a pull request from your branch to the main branch of the Vincci repository.
  • Address feedback: Respond to any feedback or requests for changes from the maintainers.

3. Improving Documentation

  • Enhance the README: Help us improve the README file by making it more informative and user-friendly.
  • Create or improve documentation:
    • Contribute to the API documentation.
    • Create tutorials or guides on how to use Vincci.

Coding Style

  • Please adhere to the existing coding style and conventions.
  • Use consistent indentation (spaces are preferred).
  • Write clear and concise code comments.

Testing

  • We encourage you to write tests for any new features or bug fixes.
  • Use a testing framework like Jest or Mocha.

Code of Conduct

Please be respectful and considerate of others when interacting with the Vincci community. We strive to maintain a welcoming and inclusive environment for all contributors.

We appreciate your contributions to Vincci!

Note: This is a basic template, and you can customize it further to fit the specific needs and expectations of your project.