Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 2.65 KB

Contributing to Convoz

Thank you for your interest in contributing to Convoz! We welcome contributions from anyone, whether you're an experienced developer or just getting started.

Ways to Contribute

You can contribute to Convoz in many ways:

💻 Code Contributions You can help improve our project by submitting code changes or bug fixes. If you're new to open source, you can start by looking at issues labeled as good first issue.

🐞Bug Reports If you encounter a bug or unexpected behavior, open an issue in our repository and provide details about the problem.

💡Feature Requests If you have an idea for a new feature, please create an issue to discuss it. We're open to new ideas and enhancements.

📜Documentation You can help improve our documentation by fixing typos, adding examples, or suggesting improvements.

Getting Started

To get started with this project, follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Clone the repository to your local machine.
  3. Install the dependencies by running npm install.
  4. Create a new branch for your changes by running git checkout -b my-new-branch.
  5. Create a new Firebase project and enable Google authentication. (See this guide to get started with Firebase.)
  6. Copy .env.example to .env and fill in the required values from your Firebase project.
  7. Start the development server by running npm start.
  8. Push your changes to your fork.
  9. Submit a pull request to the original repository.

Code Style

We use ESLint to enforce a consistent code style throughout the project. Before submitting a pull request, please run npm run lint to check for any linting errors.

Commit Guidelines

For all your commits, we recommend using gitmoji-cli for standardizing and adding meaning to your commit messages.

To install gitmoji, run the following command:

npm install -g gitmoji-cli

After installing gitmoji, you can use it to make commits:

gitmoji -c

This will open a prompt that will guide you through the process of making a commit.

Code of Conduct

We expect all contributors to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.

License

By contributing to Convoz, you agree that your contributions will be licensed under the project's LICENSE.

Happy coding! 🎉