Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 2.84 KB
Raw

Contributing to Holy Unblocker

Thank you for considering contributing to Holy Unblocker! Your contributions help us improve and provide better functionality. Please follow the guidelines below to ensure a smooth process.

Commit Message Guidelines

When making commits, please use the following format for your commit messages:

  • Feature Commits:
    Use the prefix feat: for new features.
    Example: feat: implement user signup functionality

  • Fix Commits:
    Use the prefix fix: for bug fixes.
    Example: fix: correct typo in README.md

  • Refactor Commits:
    Use the prefix refactor: for code improvements that do not change functionality.
    Example: refactor: improve performance of search algorithm

  • Chore Commits:
    Use the prefix chore: for routine tasks or maintenance.
    Example: chore: clean up old tests

  • Test Commits:
    Use the prefix test: for commits related to adding or modifying tests.
    Example: test: add tests for user authentication

  • Additions:
    Use the prefix add: for commits that include new code additions, such as functions, classes, or modules that enhance the project.
    Example: add: create user profile component

  • Updates:
    Use the prefix update: for commits that modify existing functionality, improve performance, or make changes that are not new features but enhance the current implementation.
    Example: update: enhance user profile loading performance

  • Version Changes:
    Use the format v6.x.x for version bumps. List the changes made.
    Example: v6.3.9 - Added Contributing.md, Testing Out Deployment Fixes

Prettier Configuration

We use Prettier for code formatting. Please ensure that you have Prettier installed with the provided configuration. Run Prettier before committing your changes to maintain consistent formatting. This is done via Alt + Shift + F if you are using Visual Studio Code.

Version Bumping

When updating the version in package.json, please follow the format 6.x.xx. Make sure to also update the corresponding version in src/data.json and app.json.

Pull Request Guidelines

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Create a Branch: Create a new branch for your feature or bug fix. Use a descriptive name that reflects the work you are doing.
  3. Make Your Changes: Implement your changes and ensure they follow the commit message guidelines above.
  4. Test Your Changes: If applicable, run tests to confirm your changes work as expected.
  5. Push Your Changes: Push your changes to your forked repository.
  6. Create a Pull Request: Submit a pull request to the main repository, providing a clear description of the changes and why they are necessary.

Thank you for contributing to Holy Unblocker! We appreciate your help in making our project better.