writefreely/CONTRIBUTING.md

2.1 KiB

Contributing to WriteFreely

Welcome! We're glad you're interested in contributing to the WriteFreely project.

To start, we'd suggest checking out our Phabricator board to see where the project is at and where it's going. You can also join the WriteFreely forums 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. 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 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

We gladly welcome development help, regardless of coding experience. We can also use help translating the app and documenting it!

Before writing or submitting any code, please sign our contributor's agreement so we can accept your contributions. It is substantially similar to the Apache Individual Contributor License Agreement. If you'd like to know about the rationale behind this requirement, you can read more about that here.

Once you've done that, please feel free to submit a pull request for any small improvements. For larger projects, please join our development discussions or get in touch so we can talk about what you'd like to work on.