https://github.com/patchwork-hub/communities-uis

NPM CLI to add communities features to Mastodon
https://github.com/patchwork-hub/communities-uis

mastodon patchwork

Last synced: 6 days ago
JSON representation

NPM CLI to add communities features to Mastodon

• Host: GitHub
• URL: https://github.com/patchwork-hub/communities-uis
• Owner: patchwork-hub
• Created: 2024-12-04T06:51:06.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2025-01-02T07:49:18.000Z (8 days ago)
• Last Synced: 2025-01-02T08:29:56.677Z (8 days ago)
• Topics: mastodon, patchwork
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@newsmast/patchwork-communities-cli
• Size: 162 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Patchwork Communities CLI

NPM CLI for adding communities features to Mastodon.

## Getting started

To add community features to your Mastodon project, you can run the following command under the root of your Mastodon project:

```bash

npx @newsmast/patchwork-communities-cli init

```

## Contributing

We welcome contributions! To contribute to this project, follow these steps:

1. Fork the repository.

2. Clone your forked repository to your local machine.

3. Install the dependencies:

    ```bash

    npm install

    ```

4. Build the project:

    ```bash

    npm run build

    ```

5. Link the package locally:

    ```bash

    npm link

    ```

### Commit Message Format

We use the Angular commit message format because `semantic-release` needs it. Please follow this format for your commit messages:

```

(): 

```

Examples:

```

feat(parser): add ability to parse arrays

fix(parser): handle null pointer exceptions

```

### Pull Requests

Once your work is ready, create a pull request and wait for a review. If everything is okay, we'll merge it.