Contributing

The Open Source Guides (opens in a new tab) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:

Code of Conduct

Get Involved

There are many ways to contribute , and many of them do not involve writing any code. Here's a few ideas to get started:

Simply start using Grimoire. Go through the Project Setup guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
Look through the open issues (opens in a new tab). Provide workarounds, ask for clarification, or suggest labels. Help triage issues.
If you find an issue you would like to fix, open a pull request. Issues tagged as Good first issue (opens in a new tab) are a good place to get started.
Read through the docs. If you find anything that is confusing or can be improved, you can click "Edit this page" at the bottom of most docs, which takes you to the GitHub interface to make and propose changes.
Take a look at the features requested (opens in a new tab) by others in the community and consider opening a pull request if you see something you want to work on.

Join our Community

We have the community group to discuss all things about grimoire development.

Triaging Issues and Pull Requests

One great way you can contribute to the project without writing any code is to help triage issues and pull requests as they come in.

Ask for more information if you believe the issue does not provide all the details required to solve it.
Suggest labels (opens in a new tab) that can help categorize issues.
Flag issues that are stale or that should be closed.
Ask for test plans and review code.

Our Development Process

We use GitHub (opens in a new tab) as its source of truth. The core team will be working directly there. All changes will be public from the beginning.

All pull requests will be checked by the continuous integration system, GitHub actions. There are unit tests, end-to-end tests, performance tests, style tests, and much more.

Branch Organization

We have one primary branch main and we use feature branches with deploy previews to deliver new features with pull requests.

How to use feature branching

Issues

Bugs

We use GitHub Issues (opens in a new tab) for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new, unreported bug, you can submit a bug report.

One issue, one bug: Please report a single bug per issue.
Provide reproduction steps: List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.

If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend filing an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.

Claiming issues

Development

Installation

Ensure you have Pnpm (opens in a new tab) installed.
After cloning the repository, run pnpm i in the site folder of the repository. This will install all dependencies as well as build all local packages.
To start a development server, run pnpm dev.

Code Conventions

Most important: Look around. Match the style you see used in the rest of the project. This includes formatting, naming files, naming things in code, naming things in documentation, etc.
"Attractive"
We do have Prettier (a formatter) and ESLint (a syntax linter) to catch most stylistic problems. If you are working locally, they should automatically fix some issues during every git commit.
For documentation: Do not wrap lines at 80 characters - configure your editor to soft-wrap when editing documentation.

Don't worry too much about styles in general—the maintainers will help you fix them as they review your code.

Pull Requests

So you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.

Working on your first Pull Request? You can learn how from this free video series:

How to Contribute to an Open Source Project on GitHub (opens in a new tab)

Please make sure the following is done when submitting a pull request:

Keep your PR small. Small pull requests (~300 lines of diff) are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it.
Use descriptive titles. It is recommended to follow this commit message style.

All pull requests should be opened against the main branch.

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional. If your change is specific to one/two packages, consider adding the scope. Scopes should be brief but recognizable, e.g. content-docs, theme-classic, core

The various types of commits:

feat: a new API or behavior for the end user.
fix: a bug fix for the end user.
docs: a change to the website or other Markdown documents in our repo.
refactor: a change to production code that leads to no behavior difference, e.g. splitting files, renaming internal variables, improving code style...
test: adding missing tests, refactoring tests; no production code change.
chore: upgrading dependencies, releasing new versions... Chores that are regularly done for maintenance purposes.
misc: anything else that doesn't change production code, yet is not test or chore. e.g. updating GitHub actions workflow.

Do not get too stressed about PR titles, however. Your PR will be squash-merged and your commit to the main branch will get the title of your PR, so commits within a branch don't need to be semantically named. The maintainers will help you get the PR title right, and we also have a PR label system that doesn't equate with the commit message types. Your code is more important than conventions!

Example:

Terminal

feat(core): allow overriding of webpack config
^--^^----^  ^------------^
|   |       |
|   |       +-> Summary in present tense. Use lower case not title case!
|   |
|   +-> The package(s) that this change affected.
|
+-------> Type: see above for the list we use.

Breaking Changes

When adding a new breaking change, follow this template in your pull request:

### New breaking change here
 
- **Who does this affect**:
- **How to migrate**:
- **Why make this breaking change**:
- **Severity (number of people affected x effort)**:

What Happens Next?

The core team will be monitoring pull requests. Do help us by keeping pull requests consistent by following the guidelines above.

Design Scope