Thank you for your interest in contributing to Writer Framework.
Beyond contributing to the repository, some ways to contribute to this project include:
- Reporting bugs. Bug reports are relatively easy to write, but have a big impact. Please include the steps required to reproduce the bug. Use "Issues" on GitHub. This is an example of a wonderful bug report.
- Creating content. Think articles or tutorials. It doesn't have to be overwhelmingly positive; constructive criticism is appreciated. A great example is this review. A YouTube tutorial would be fantastic!
- Browse Issues and Discussions. Browse these sections on GitHub and see if you can help.
- Suggesting valuable enhancements. If you think of a feature that can have a positive impact, suggest it. Please use the "Discussions" on GitHub.
- Sponsoring the project. Helps offset hosting and other expenses.
- Promoting the project. Star it, share on LinkedIn or other social media.
If you wish to contribute to the repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Failure to discuss the changes beforehand will likely cause your pull request to be rejected, regrettably.
Make sure to run the tests, which can be found in /tests, and pass mypy validation. Code formatting is important; Prettier is used in the frontend while autopep8 is used in the backend.
Pull requests should be done on the dev branch. When the release is finalised, dev will be merged into master.
Whether you're interested in contributing to the repository, creating a fork, or just improving your understanding of Writer Framework, these are the suggested steps for setting up a development environment.
- You can install the package in editable mode using
poetry install - Enable the virtual environment with
poetry shell - Install all the dev dependencies with
alfred install.dev - Run Writer Framework on port 5000. For example,
writer edit apps/hello --port 5000.