GitHub.dart is of course Open Source! We love it when people contribute!
- Make sure you have a GitHub Account.
- Make sure the Dart SDK is installed on your system.
- Make sure you have Git installed on your system.
- Fork the repository on GitHub.
- Create a branch for your changes.
- Commit your code for each logical change (see tips for creating better commit messages).
- Push your change to your fork.
- Create a Pull Request on GitHub for your change.
- Wait for reviewers (usually robrbecker) to give feedback.
- When the reviewers think that the Pull Request is ready, they will merge it.
GitHub.dart follows the Dart Style Guide. Please note that if your code is not formatted according to the guide as much as possible, we will reject your Pull Request until it is fixed. Some things such as long lines will generally be accepted, however try to make it smaller if possible.
GitHub.dart is committed to efficiency as much as possible. If your code is not efficient, then we will probably reject your Pull Request.
Pull Request rejections are not a bad thing. It just means you need to fix something. Perhaps it is important to define 'rejection' as it is used in this case. A rejection is when a GitHub.dart committer comments on a Pull Request with a comment like 'rejected due to incorrect formatting'.
To regenerate the JSON logic for the models, run:
dart run build_runner build -ddart test will only run the unit tests.
To run the complete test suite you will need to install
octokit/fixtures-server.
npm install --global @octokit/fixtures-server
Tests can be run using make test, which will start up a local mock
GitHub and execute tests against it using your localhost port 3000.
File issues at https://github.com/SpinlockLabs/github.dart/issues
Merged pull requests that edit the pubspec.yaml version will create new releases.
Once CI is green, it will create a tag for that commit based on the version, which
gets published by pub.dev.
If no new version was created, nothing will be published.