Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (58 loc) · 4.03 KB

CONTRIBUTING.md

File metadata and controls

91 lines (58 loc) · 4.03 KB

Contributing

Thank you for your interest in contributing to Shadboard! We're excited to have you join our open-source project and appreciate your willingness to help enhance it. Whether you're fixing bugs, adding new features, or improving documentation, every contribution makes a significant impact.

Before submitting your first pull request, please review this document to help ensure that your contributions align with the project's goals and guidelines. We also encourage you to check for open issues and pull requests to avoid duplication of work.

How to Contribute

1. Fork the Repository

  • Fork the Shadboard repository to your own GitHub account by clicking the "Fork" button at the top of the repository page.

2. Clone Your Fork

  • After forking, clone the repository to your local machine:

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

3. Navigate to project directory

cd full-kit

4. Create a new Branch

git checkout -b my-new-branch

5. Set Up Environment Variables

Before running the project locally, you need to configure your environment variables. Use the provided .env.example file to create your own .env file:

cp .env.example .env
  • Make any necessary modifications to the .env file based on your local setup.
  • Never commit .env file—only .env.example should be tracked in version control.

5. Install dependencies

pnpm install

6. Run the development server locally

pnpm run dev

Keep starter-kit and full-kit in Sync

If your contribution involves code that exists in both the full-kit and starter-kit directories (e.g., shared components, layout structure, configuration), please make sure to reflect any applicable changes in both directories.

  • The full-kit contains the complete feature set, while the starter-kit is a minimal version designed for quick starts.
  • When updating or adding features in full-kit, check if the same component or logic also exists in starter-kit.
  • If the feature involves Internationalization (I18n), Authentication, or Customizer, these features are not included in starter-kit, so you must remove these features before adding the code to starter-kit.

This ensures that the starter-kit remains lean and free from dependencies that may not be required by all users.

Keeping both kits aligned helps us avoid drift and ensures a smooth developer experience across setups.

Commit Convention

Before submitting a pull request, we kindly ask that you check whether your commits align with the conventions used in this repository. This helps maintain consistency and clarity in the commit history.

When creating a commit, please follow the convention of using the format category(scope or module): message for your commit messages. Below are the categories to choose from:

  • feat / feature: Changes that introduce new code or new features.
  • fix: Changes that fix a bug (ideally referencing an issue if present).
  • refactor: Code changes that neither fix a bug nor add a feature.
  • docs: Changes to documentation, such as updates to the README or usage instructions.
  • build: Changes related to the build process or the addition/removal of dependencies.
  • test: Changes related to tests, such as adding or modifying tests.
  • ci: Changes to continuous integration configuration (e.g., GitHub Actions, CI systems).
  • chore: Miscellaneous changes that don't fit into any of the categories above.

Example Commit Message:

feat(components): add new prop to the avatar component

If you'd like more details on the convention, you can visit Conventional Commits or refer to the Angular Commit Message Guidelines.

We appreciate your cooperation in helping us keep the project's commit history clean and easy to follow!