Skip to content

Latest commit

 

History

History
84 lines (51 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

84 lines (51 loc) · 2.99 KB
Raw

Contributing to HarmonyCode

Thank you for your interest in contributing to HarmonyCode! We welcome contributions from everyone. By contributing to this project, you help us create a more vibrant and inclusive community.

Table of Contents

Getting Started

Fork the Repository

To contribute to this project, you will need to fork the repository to your GitHub account. Click the "Fork" button at the top right of the repository page.

Clone the Repository

Clone the repository to your local machine using the following command, replacing <username> with your GitHub username:

git clone https://github.com/<username>/HarmonyCode.git
cd HarmonyCode

Setting Up Firebase Environment Variables

Follow the instructions in the Setting Up Firebase Environment Variables section of the README to set up Firebase environment variables.

Making Contributions

Creating Issues

If you encounter bugs, have feature requests, or want to suggest improvements, please create an issue. Provide a clear and detailed description of the issue or enhancement you are suggesting.

Working on Issues

If you want to work on an existing issue, assign yourself to that issue and make sure to follow the coding standards. Fork the repository, create a new branch for your contribution, and submit a pull request.

Submitting Pull Requests

Follow these steps to submit a pull request:

  1. Fork the repository and create a new branch for your contribution:

    git checkout -b feature/new-feature

  2. Make your changes, ensuring they follow the coding standards.

  3. Commit and push your changes:

    git add .
git commit -m "Add new feature"
git push origin feature/new-feature

  4. Open a pull request on GitHub from your fork to the main branch of the original repository.

  5. Describe your changes and mention the relevant issue numbers in the pull request description.

  6. Wait for a maintainer to review your pull request and provide feedback.

Coding Standards

Maintain consistent coding standards when contributing to this project. Adhere to the established conventions and follow best practices.

Acknowledgement

If you liked this project, support it by starring it 🌟 and share it on social media.

Thank you for your contributions to HarmonyCode! 🎉 We appreciate your help in making this project better and more enjoyable for everyone.