nyastodon/CONTRIBUTING.md
Thibaut Girka dcded13a99 Merge branch 'master' into glitch-soc/merge-upstream
Conflicts:
- .github/ISSUE_TEMPLATE/bug_report.md
  Took our version.
- CONTRIBUTING.md
  Updated the embedded copy of upstream's version.
- README.md
  Took our version.
- app/policies/status_policy.rb
  Not a real conflict, took code from both.
- app/views/layouts/embedded.html.haml
  Added upstream's changes (dns-prefetch) and fixed
  `%body.embed`
- app/views/settings/preferences/show.html.haml
  Reverted some of upstream changes, as we have a
  page dedicated for flavours and skins.
- config/initializers/content_security_policy.rb
  Kept our version of the CSP.
- config/initializers/doorkeeper.rb
  Not a real conflict, took code from both.
2018-10-22 17:51:38 +02:00

3.2 KiB

Contributing to Mastodon Glitch Edition

Thank you for your interest in contributing to the glitch-soc project! Here are some guidelines, and ways you can help.

(This document is a bit of a work-in-progress, so please bear with us. If you don't see what you're looking for here, please don't hesitate to reach out!)

Planning

Right now a lot of the planning for this project takes place in our development Discord, or through GitHub Issues and Projects. We're working on ways to improve the planning structure and better solicit feedback, and if you feel like you can help in this respect, feel free to give us a holler.

Documentation

The documentation for this repository is available at glitch-soc/docs (online at glitch-soc.github.io/docs/). Right now, we've mostly focused on the features that make this fork different from upstream in some manner. Adding screenshots, improving descriptions, and so forth are all ways to help contribute to the project even if you don't know any code.

Frontend Development

Check out the documentation here for more information.

Backend Development

See the guidelines below.


You should also try to follow the guidelines set out in the original CONTRIBUTING.md from tootsuite/mastodon, reproduced below.

CONTRIBUTING

Contributing

Thank you for considering contributing to Mastodon 🐘

You can contribute in the following ways:

  • Finding and reporting bugs
  • Translating the Mastodon interface into various languages
  • Contributing code to Mastodon by fixing bugs or implementing features
  • Improving the documentation

Bug reports

Bug reports and feature suggestions can be submitted to GitHub Issues. Please make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected in the past using the search function. Please also use descriptive, concise titles.

Translations

You can submit translations via Weblate. They are periodically merged into the codebase.

Mastodon translation statistics by language

Pull requests

Please use clean, concise titles for your pull requests. We use commit squashing, so the final commit in the master branch will carry the title of the pull request.

The smaller the set of changes in the pull request is, the quicker it can be reviewed and merged. Splitting tasks into multiple smaller pull requests is often preferable.

Pull requests that do not pass automated checks may not be reviewed. In particular, you need to keep in mind:

  • Unit and integration tests (rspec, jest)
  • Code style rules (rubocop, eslint)
  • Normalization of locale files (i18n-tasks)

Documentation

The Mastodon documentation is a statically generated site. You can submit merge requests to mastodon/docs.