Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.92 KB
Raw

Contributing to StoryLines

We appreciate your interest in contributing to StoryLines! Your contributions are valuable in making our platform better. This guide will help you understand how to contribute effectively.

Pull Request Guidelines

Don't be concerned if you're unsure about any of these guidelines. We're here to help and guide you through the process.

Pull Request Titles

Each pull request title should begin with a semantic prefix that describes the primary purpose of the changes:

  • feat: Introduces a new feature
  • fix: Addresses a bug
  • docs: Changes or adds documentation
  • style: Makes code style changes (whitespace, formatting, missing semicolons, etc.)
  • refactor: Improves code structure without changing functionality
  • perf: Enhances performance
  • test: Adds or modifies tests
  • build: Alters the build system or external dependencies
  • ci: Updates CI configuration files and scripts
  • chore: Performs routine tasks or maintenance
  • revert: Reverts a previous commit

Example of a well-formatted pull request title:

feat: implement search functionality for theme rooms

Getting Started

To contribute to StoryLines, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make and commit your changes.
  5. Push your changes to your fork on GitHub.
  6. Submit a pull request to the main StoryLines repository.

Code of Conduct

By participating in this project, you agree to adhere to our Code of Conduct. Please read it before contributing.

Questions or Concerns?

If you have any questions or concerns, please don't hesitate to open an issue in the Issues section of the repository.

Thank you for contributing to StoryLines! Your efforts help make our platform better for everyone.