forks/writefreely
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update CONTRIBUTING.md and README.md to indicate that this is a fork

Browse Source
This commit is contained in:
Nick Thomas
2018-11-13 00:58:13 +00:00
parent a0ac7bbbcd
commit e15ca16d17
2 changed files with 14 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md
View File

@@ -1,26 +1,9 @@
# Contributing to WriteFreely
# Contributing to WriteFreely (lupine's fork)
Welcome! We're glad you're interested in contributing to the WriteFreely project.
This is a fork of https://github.com/writeas/writefreely
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.
You probably want to contribute there instead of here.
## 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
We gladly welcome development help, regardless of coding experience. We can also use help [translating the app](https://poeditor.com/join/project/TIZ6HFRFdE) and documenting it!
**Before writing or submitting any code**, please sign our [contributor's agreement](https://phabricator.write.as/L1) 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](https://phabricator.write.as/w/writefreely/cla/).
Once you've done that, please feel free to [submit a pull request](https://github.com/writeas/writefreely/pulls) for any small improvements. For larger projects, please [join our development discussions](https://discuss.write.as/c/writefreely) or [get in touch](https://write.as/contact) so we can talk about what you'd like to work on.
Note that I haven't signed their CLA, which means they won't accept my code. So
that's why this is a fork. I'm not doing this to be a pain, I just don't want to
run a mysql server on the limited hardware I have at home.