Thanks for your interest in Guppy! We are open to, and grateful for, any contributions made by the community. We want Guppy to be a community endeavour, all of us working together to make web development more accessible for folks who don't have terminal experience!
Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.
Guppy is alpha software, and you will likely encounter some issues.
We use the issue tracker to keep track of bugs and improvements to Guppy itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.
Visit the issue tracker to find a list of open issues that need attention. The best way to contribute is to find something you feel able and willing to tackle. As the project matures we hope to add more "good first contribution" issues for folks newer to React development.
Fork, then clone the repo:
git clone https://github.com/your-username/guppy.git
You can get started developing locally by running the start task:
npm run start
This should open an Electron window with the application running.
In development, all projects are created at ~/guppy-projects-dev
You can build a MacOS executable by running:
npm run package
The result will be in the release-builds folder.
Unfortunately, very little of Guppy is currently tested.
We hope to add more tests in the meantime, as well as add CI integration to run tests on push, but for now you can run the tests with:
npm run test
This project uses Flow, and the types can be checked with:
npm run flow
This project uses Prettier, this should be run automatically on commit.
Please learn more about Guppy at the project README, or the docs located in the /docs directory.
For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work, or comment on an existing requested-feature issue. We don't want you to waste your efforts on a pull request that we won't want to accept.
On the other hand, sometimes the best way to start a conversation is to send a pull request. Use your best judgement!
In general, the contribution workflow looks like this:
- Find or open a new issue in the Issue tracker.
- Fork the repo.
- Create a new feature branch based off the
masterbranch. - Make sure all tests pass
- Submit a pull request, referencing any issues it addresses.
Please try to keep your pull request focused in scope and avoid including unrelated commits.
After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.
Thank you for contributing!