Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

72 lines (53 loc) · 2.5 KB

Contributing to Vaicom Pro Community

Thank you for your interest in contributing to the VaiCom Pro Community! We appreciate your help in improving the project. Please follow the guidelines below to ensure a smooth collaboration.

Getting Started

1. Fork the Repository

  • Navigate to the VaiCom Pro Community GitHub repository.
  • Click on the Fork button to create your own copy.

2. Clone the Repository

$ git clone https://github.com/your-username/vaicom-pro-community.git
$ cd vaicom-pro-community

3. Create a Branch

  • Use a descriptive branch name that reflects the changes you are making.
$ git checkout -b feature-branch-name

Making Changes

4. Follow Code and Documentation Standards

  • Ensure your code follows the project's style guidelines.
  • Update documentation if necessary.

5. Test Your Changes

  • If applicable, test your changes before submitting them.
  • Ensure that your changes do not introduce new bugs or issues.

6. Commit and Push

$ git add .
$ git commit -m "Brief description of your changes"
$ git push origin feature-branch-name

Submitting a Pull Request (PR)

7. Open a PR

  • Navigate to the Pull Requests tab in the original repository.
  • Click New Pull Request and select your branch.
  • Provide a clear and concise description of your changes.

8. Address Feedback

  • Be prepared to update your PR based on feedback from maintainers.
  • Discuss any concerns or questions in the PR comments.

Reporting Issues

If you encounter any issues while using VaiCom Pro, please follow these steps to report them:

  1. Check for Existing Issues: Before reporting a new issue, browse the Issues to see if it has already been reported.
  2. Create a New Issue:
    • Go to the Issues tab and click New Issue.
    • Provide a clear and concise title for your issue.
    • Describe the problem in detail, including steps to reproduce, expected behavior, and actual behavior.
    • Attach relevant screenshots, logs, or other supporting information.
  3. Engage in Discussion: Maintain a respectful and constructive conversation as the maintainers and community members investigate your issue.

Community Guidelines

  • Be respectful and constructive in discussions.
  • Follow the Code of Conduct.
  • Help others by reviewing PRs and providing feedback.

Need Help?

If you have any questions, feel free to open an issue or reach out to the community.

Happy coding! 🚀