diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b7a7c8..efe343a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,21 @@ -# Contributing to Write Freely +# Contributing to WriteFreely -Welcome! We're glad you're interested in contributing to the Write Freely project. +Welcome! We're glad you're interested in contributing to the WriteFreely project. -To start, we'd suggest checking out [our Phabricator board](https://phabricator.write.as/tag/write_freely/) to see where the project is at and where it's going. You can also [join the Write Freely forums](https://discuss.write.as/c/writefreely) to start talking about what you'd like to do or see. +To start, we'd suggest checking out [our Phabricator board](https://phabricator.write.as/tag/write_freely/) to see where the project is at and where it's going. You can also [join the WriteFreely forums](https://discuss.write.as/c/writefreely) to start talking about what you'd like to do or see. + +## Asking Questions + +The best place to get answers to your questions is on [our forums](https://discuss.write.as/c/writefreely). You can quickly log in using your GitHub account and ask the community about anything. We're also there to answer your questions and discuss potential changes or features. + +## Submitting Bugs + +Please use the [GitHub issue tracker](https://github.com/writeas/writefreely/issues/new) to report any bugs you encounter. We're very responsive there and try to keep open issues to a minimum, so you can help by: + +* **Only reporting bugs in the issue tracker** +* Providing as much information as possible to replicate the issue, including server logs around the incident +* Including the `[app]` section of your configuration, if related +* Breaking issues into smaller pieces if they're larger or have many parts ## Contributing code