Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 4.72 KB

Contribute to Code Vedas Template Repository

Thank you for expressing your interest in contributing to Code Vedas Template Repository. Your contributions are highly valued, and we appreciate your commitment to enhancing this project. Before initiating any contribution, we kindly request you to carefully review this document.

Feel free to contribute through various avenues such as suggestions, comments, bug reports, or pull requests. To do so, please open an issue or a pull request directly in the repository.

Community Engagement

There are several ways to become an active part of our community:

  1. Create an issue in the repository.
  2. Join our mailing list by sending an email to Join mailing list.
  3. Participate in our Slack channel by sending an email to Join slack.
  4. Apply for project membership by sending an email to Join project. Following an initial screening, an invitation will be extended to you. This membership allows you to create issues, pull requests, and more, directly in the repository without the need to fork it.
  5. If you wish to make a financial contribution, please follow GitHub's instructions for donating to the project.

Code and Documentation

We encourage contributions to both the codebase and documentation.

This project comprises various modules/components, each housed in its dedicated folder/repository. For detailed information, please refer to the README.md file in each respective folder/repository.

The table below provides an overview of all possible modules/components:

Module/Component Description Related Language/Framework
GraphQL API GraphQL API CV-GraphQL
Middleware Middleware Ruby on Rails
UI UI Flutter
Mobile App Mobile App Flutter
Desktop App Desktop App Flutter
CLI CLI Ruby, Dart, Flutter
DevOps DevOps Terraform, AWS
Security Security Terraform, AWS
Documentation Documentation Markdown

Improve Documentation

Contributions to the documentation, including this file, are highly welcomed.

Two ways to contribute to the documentation:

  1. Create an issue in the repository with the suggested changes using the appropriate template.
  2. Submit a pull request in the repository with the suggested changes, adhering to the specified template.

Both approaches are applicable to this file as well, following the outlined code of conduct.

Improve Code

Your contributions to the codebase are appreciated. Refer to the README.md file in each folder/repository for detailed information.

Two ways to contribute to the code:

  1. Open an issue in the repository with the suggested changes, using the appropriate template.
  2. Submit a pull request in the repository with the suggested changes, following the specified template.

Pull Request

Before creating a pull request, ensure the following:

  1. Download and install the code on your local machine.
  2. Set up the development environment and verify that it is functioning as expected.
  3. Create a branch for your changes, ensuring they work as intended. The branch name should follow the format feature/<feature-name>, bugfix/<bug-name>, hotfix/<hotfix-name>, etc.
  4. Run applicable test suites, confirming that all tests pass.
  5. Ensure the code adheres to coding standards and best practices.
  6. Provide thorough documentation for the changes made.
  7. When creating a PR, select the correct template and complete all details. If the template is unavailable, create an issue in the repository for template addition. Failure to complete the template may result in the PR being closed without action.

Issue

Before creating an issue, perform the following:

  1. Invest time in finding a solution to the problem (if applicable).
  2. When creating an issue, select the correct template and complete all details. If the template is absent, create an issue in the repository to request its addition. Failure to complete the template may lead to the issue being closed without action.

Both approaches are suitable for various changes, including bug fixes and new features, while adhering to the code of conduct.

Enhance Security

Contributions to the security aspects of the project are highly appreciated. To report a security vulnerability, please follow the instructions outlined in the SECURITY.md file.