focalboard/docs/index.md

20 lines
1.6 KiB
Markdown
Raw Normal View History

2022-02-08 23:05:17 +01:00
# Focalboard / Mattermost Boards Contributors Guide
2022-02-08 18:56:58 +01:00
2022-02-08 23:05:17 +01:00
Welcome to the [Focalboard](https://www.focalboard.com) / [Mattermost Boards](https://mattermost.com/boards/?utm_source=focalboard) project!
2022-02-08 18:56:58 +01:00
We're very glad you want to check it out and perhaps contribute code our repository in GitHub.
2022-02-08 18:56:58 +01:00
Our goal is to make your experience as great as possible. Follow these simple steps to contribute:
2022-02-08 18:56:58 +01:00
1. [Fork the Focalboard repo](https://github.com/mattermost/focalboard), clone it locally, and follow the steps in the README to build. Read the [developer tips & tricks](dev-tips.md) to get started.
2022-02-08 18:56:58 +01:00
2. Find [help wanted tickets that are up for grabs in GitHub](https://github.com/mattermost/focalboard/issues?q=is%3Aopen+is%3Aissue+label%3A%22Up+for+grabs%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).
2022-02-08 18:56:58 +01:00
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.
2022-02-08 18:56:58 +01:00
## Just ask if you need help!
2022-02-08 18:56:58 +01:00
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).
2022-02-08 18:56:58 +01:00
We're glad ❤️ you're here! Good luck and have fun!