CONTRIBUTING.md 3.28 KB
Newer Older
kibigo!'s avatar
kibigo! committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
#  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  ##

Gô Shoemake's avatar
Gô Shoemake committed
16
The documentation for this repository is available at [`glitch-soc/docs`](https://github.com/glitch-soc/docs) (online at [glitch-soc.github.io/docs/](https://glitch-soc.github.io/docs/)).
kibigo!'s avatar
kibigo! committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
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](https://glitch-soc.github.io/docs/contributing/frontend/) 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.

<blockquote>

Eugen Rochko's avatar
Eugen Rochko committed
34
CONTRIBUTING
35
=======
Eugen Rochko's avatar
Eugen Rochko committed
36
Contributing
Eugen Rochko's avatar
Eugen Rochko committed
37

38
Thank you for considering contributing to Mastodon 🐘
Eugen Rochko's avatar
Eugen Rochko committed
39

Eugen Rochko's avatar
Eugen Rochko committed
40
You can contribute in the following ways:
Eugen Rochko's avatar
Eugen Rochko committed
41

Eugen Rochko's avatar
Eugen Rochko committed
42 43 44 45
- Finding and reporting bugs
- Translating the Mastodon interface into various languages
- Contributing code to Mastodon by fixing bugs or implementing features
- Improving the documentation
46

47 48
If your contributions are accepted into Mastodon, you can request to be paid through [our OpenCollective](https://opencollective.com/mastodon).

Eugen Rochko's avatar
Eugen Rochko committed
49
## Bug reports
Eugen Rochko's avatar
Eugen Rochko committed
50

sclaire-1's avatar
sclaire-1 committed
51
Bug reports and feature suggestions must use descriptive and concise titles and be submitted to [GitHub Issues](https://github.com/tootsuite/mastodon/issues). Please use the search function to make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected.
Eugen Rochko's avatar
Eugen Rochko committed
52

Eugen Rochko's avatar
Eugen Rochko committed
53
## Translations
Eugen Rochko's avatar
Eugen Rochko committed
54

55 56
You can submit translations via [Crowdin](https://crowdin.com/project/mastodon). They are periodically merged into the codebase.

57
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/mastodon/localized.svg)](https://crowdin.com/project/mastodon)
Eugen Rochko's avatar
Eugen Rochko committed
58

Eugen Rochko's avatar
Eugen Rochko committed
59
## Pull requests
Eugen Rochko's avatar
Eugen Rochko committed
60

Eugen Rochko's avatar
Eugen Rochko committed
61
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.
Eugen Rochko's avatar
Eugen Rochko committed
62

Eugen Rochko's avatar
Eugen Rochko committed
63
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.
Eugen Rochko's avatar
Eugen Rochko committed
64

Eugen Rochko's avatar
Eugen Rochko committed
65
**Pull requests that do not pass automated checks may not be reviewed**. In particular, you need to keep in mind:
Eugen Rochko's avatar
Eugen Rochko committed
66

Eugen Rochko's avatar
Eugen Rochko committed
67 68 69
- Unit and integration tests (rspec, jest)
- Code style rules (rubocop, eslint)
- Normalization of locale files (i18n-tasks)
kibigo!'s avatar
kibigo! committed
70

Eugen Rochko's avatar
Eugen Rochko committed
71
## Documentation
72

Eugen Rochko's avatar
Eugen Rochko committed
73
The [Mastodon documentation](https://docs.joinmastodon.org) is a statically generated site. You can [submit merge requests to mastodon/docs](https://source.joinmastodon.org/mastodon/docs).
74

kibigo!'s avatar
kibigo! committed
75
</blockquote>