Skip to content

Latest commit

 

History

History
110 lines (64 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

110 lines (64 loc) · 3.87 KB
Raw

Contributing To AI Saas Base App Template

Thank you for considering contributing to our project! We welcome contributions from the community to help improve and grow our project. Please take a moment to read the following guidelines.

Code Of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms. Please read the full Code of Conduct here.

How To Contribute

We welcome contributions in the form of bug reports, feature requests, code changes, and more. You can find the open issues in the tracking boards of the project. Multiple clean contributions can result in invitation to join the internal team at Existence. Here's how you can contribute:

  1. Understand the Project:

    Before contributing, familiarize yourself with the project. Read the README, contributing guidelines, and any documentation available to understand the project's structure and conventions.

  2. Choose an Issue:

    Browse the repository's issues to find one you're interested in or feel you can address. Issues are usually labeled to indicate their difficulty or type.

  3. Comment on the Issue:

    Comment on the issue expressing your interest in working on it. This helps avoid duplicate efforts and allows maintainers to guide you.

  4. Fork the Repository:

    Fork the repository to create your own copy on GitHub. This will be the space where you make your changes.

  5. Clone Your Fork:

    Clone your forked repository to your local machine using the git clone command. This gives you a local copy of the codebase.

    git clone https://github.com/your-username/repository.git

  6. Create Branch

    Create a new branch for your contribution:

    git checkout -b feature/your-feature

    or

    git checkout -b bugfix/your-bugfix

  7. Make Changes

    Make the necessary code changes to address the issue you're working on. Ensure your changes follow the project's coding standards.

  8. Commit Changes

    Commit your changes using descriptive commit messages.

    git add .
git commit -m "description of your changes"

  9. Push Changes

    Push your changes to your forked repository:

    git push origin branch-name

  10. Create a Pull Request (PR)

    Go to your forked repository on GitHub and create a pull request. This informs the project maintainers that you have changes you'd like them to review and merge into the main codebase. Provide a clear and concise description of your changes in the pull request.

  11. Follow Up

    Engage in discussions with maintainers and address any feedback. Be responsive to comments on your pull request. The result can be a merger of your pull request. Congrats! Or in other case, don't despair, you can try for other issues.

Code Style

Please follow our coding style guide to maintain consistency in the codebase. If you're unsure about the style, check the existing code for reference.

Reporting Bugs

If you encounter a bug, please open a GitHub issue with the following information:

  • A clear and descriptive title.
  • Steps to reproduce the bug.
  • Expected behavior.
  • Actual behavior.
  • Any relevant error messages or screenshots.

Feature Requests

We encourage you to submit feature requests to help improve the project. Please provide the following information:

  • A clear and descriptive title.
  • The context and motivation for the new feature.
  • Any additional details or considerations.

Code Review

All contributions will go through a code review process before being merged. Be prepared to address feedback and make necessary changes to your code.

License

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

Thank you for contributing to Bloomify 🚀