Skip to content

Commit

Permalink
Update readme, add contributing guide (#1653)
Browse files Browse the repository at this point in the history
  • Loading branch information
rafalp authored Nov 8, 2023
1 parent b253ff7 commit 7ea51b4
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 14 deletions.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Contributing
============

Thank you for taking an interest in contributing to Misago!

This document is a short guide for common contributions:


Translations
------------

Misago's translations are maintained on a separate service, [Transifex](https://explore.transifex.com/misago/). To contribute translations create an account there and request to join your language's translation team or request new language being added if a translation for it doesn't exist yet.

Pull requests with new translations on GitHub will be rejected.


Working on existing issue
-------------------------

Unless the issue is assigned to somebody, it's considered available for taking.

Please note that some of the issues may be very old and not up to date anymore. **Always ask** in the issue first before actually starting development.


Feature requests and improvement suggestions
--------------------------------------------

Unless the feature or improvement is 100% code-oriented and transparent to the end users, please first post a proposal for it on the [project's forums](https://misago-project.org/c/feedback/28/) for others to discuss and provide their feedback.

Please note that I am rejecting features that:

- I am unable to personally commit to maintain in the future.
- That are out of scope of the project.
- Are too tailored for a specific use case and won't be helpful to the vast majority of Misago users.

Even if I reject a feature, usually I am still be open to including new extension points in Misago to make such a feature possible through a plugin.


New pull requests
-----------------

Pull requests fixing bugs, spelling or updating dependencies are welcome.

New feature pull requests won't be merged if they were not preceded by a discussion on the [project's forums](https://misago-project.org/c/feedback/28/) and green lit by me (see the above section).

Pull requests not associated with any issue or forum discussion must contain an explanation of why the change is introduced in the first place. Misago is a large codebase, and I am not always able to discern the intended purpose of the change from the code alone.

Thank you!
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ The `./dev` utility implements other features besides the `init`. Run it without

### Running Misago in development without `dev`


You may skip `./dev init` and setup dev instance manually, running those commands:

1. `docker compose build`: builds docker containers
Expand All @@ -94,25 +93,19 @@ Currently Misago defines following taks:

To start work on custom frontend for Misago, fork and install it locally to have development forum setup. You can now develop custom theme by modifying assets in `frontend` directory, however special care should be taken when changing source javascripts.

Misago defines template that allows you to include custom html and js code before Misago's JavaScript app is ran, named `scripts.html`.


Bug reports, features and feedback
----------------------------------

If you have found bug, please report it on [issue tracker](https://github.com/rafalp/Misago/issues).
Misago defines template that allows you to include custom html and JavaScript code before Misago's JavaScript app is ran, named `scripts.html`.

For feature or support requests as well as general feedback please use [official forum](http://misago-project.org) instead. Your feedback means much to the project so please do share your thoughts!

There's also Gitter for those looking for instant-messaging approach for discussing Misago development.
Providing feedback and contributing
-----------------------------------

If you have found a bug, please report it either on the [issue tracker](https://github.com/rafalp/Misago/issues) or on the [project's forums](hhttps://misago-project.org/c/bug-reports/29/).

Contributing
------------
If you want to contribute to project, please see the [contributing](./CONTRIBUTING.md) document.

If you have corrected spelling, wrote new tests or fixed a bug, feel free to open pull request.
For feature or support requests as well as general feedback please use the [official forums](http://misago-project.org). Your feedback means much to the project so please do share your thoughts!

Many issues are open for takers. If you've found one you feel you could take care of, please announce your intent in issue discussion before you start working. That way situations when more than one person works on solving same issue can be avoided.
There's also a [Discord server](https://discord.gg/fwvrZgB) for those looking for instant-messaging approach for getting in touch with Misago devs and users.


Authors
Expand Down

0 comments on commit 7ea51b4

Please sign in to comment.