👋 Thanks for your interest in contributing to the WIP app! I’m glad you're here and excited to help you get started if you have any questions. For now, here are some basic instructions for how I manage this project.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Setup the repository
git clone [email protected]:wip/app.git wip-app
cd wip-app
npm install
Run the tests
npm test
If you see an error than something is wrong with the setup. Usually the error message and some research online should be enough to resolve it. But if you can’t figure it out please create an issue and I’ll try to help you out.
Once the setup looks good, you can follow the Probot documentation to create and configure your own GitHub app.
If you run into a problem with the app, please create an issue describing how to reproduce it. Ideally you will be able to create an automated test that reproduces the problem. You can start a pull request with just a failing test, we can then collaborate on resolving the problem.
Note that the WIP is simple by design. I’m sure there are plenty of features that could be added with just a little bit of code. But in most cases we probably won’t add it to the WIP itself. But please suggest it anyway, we can have a discussion and maybe you can create your own application with additional features and WIP some users might be interested in using it instead of WIP. I’d be happy to mention your app in the README.md once we have a few "forks" that are worth mentioning.