focalboard/docs/index.md

19 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Focalboard / Mattermost Boards Contributors Guide
Welcome to the [Focalboard](https://www.focalboard.com) / [Mattermost Boards](https://mattermost.com/boards/?utm_source=focalboard) project!
We're very glad you want to check it out and perhaps contribute code our repository in GitHub.
Our goal is to make your experience as great as possible. Follow these simple steps to contribute:
1. [Clone the project from GitHub](https://github.com/mattermost/focalboard) and follow the steps in the README to build. Read the [developer tips & tricks](dev-tips.md) to get started.
2. Find [help wanted tickets in GitHub](https://github.com/mattermost/focalboard/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). Comment to let everyone know youre working on it, and to allow a core contributor to assign the issue to you. If theres no ticket for what you want to work on see [contributions without a ticket.](contributions-without-ticket.md).
3. When your changes are ready, run through our [checklist for pull requests](contribution-checklist.md). Note that if its your first contribution, there is a standard [CLA](https://www.mattermost.org/mattermost-contributor-agreement/) to sign.
## Just ask if you need help!
You can find us on our [public Focalboard channel](https://community.mattermost.com/core/channels/focalboard) on the Mattermost community server. Also feel free to [file a bug](https://github.com/mattermost/focalboard/issues/new/choose) for any issues you run into, or [start a discussion](https://github.com/mattermost/focalboard/discussions).
We're glad ❤️ you're here! Good luck and have fun!