Skip to content

Latest commit

 

History

History
72 lines (58 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

72 lines (58 loc) · 3.36 KB
Raw

Contributing to GirFFI

I welcome contributions to GirFFI. Please follow the guidelines below to help the process of handling issues and pull requests go smoothly.

Issues

When creating an issue, please provide as much information as possible, and follow the guidelines below to make it easier for me to figure out what's going on. If you miss any of these points I will probably ask you to improve the ticket.

  • Include a clear title describing the problem
  • Describe what you are trying to achieve
  • Describe what you did, preferably including relevant code
  • Describe what you expected to happen
  • Describe what happened instead. Include relevant output if possible
  • State the version of GirFFI you are using
  • Use code blocks to format any code and output in your ticket to make it readable.

Pull Requests

If you have an idea for a particular feature, it's probably best to create a GitHub issue for it before trying to implement it yourself. That way, we can discuss the feature and whether it makes sense to include in GirFFI itself before putting in the work to implement it.

When sending a pull request, please follow all of the instructions below:

  • Make sure bundle exec rake runs without reporting any failures. See Testing your changes below for more details.
  • Add tests for your feature. Otherwise, I can't see if it works or if I break it later.
  • Create a separate branch for your feature based off of latest master.
  • Write good commit messages.
  • Do not include changes that are irrelevant to your feature in the same commit.
  • Keep an eye on the build results in GitHub Actions. If the build fails and it seems due to your changes, please update your pull request with a fix.

If you're not sure how to test the problem, or what the best solution is, or get stuck on something else, please open an issue first so that we can discuss the best approach.

Testing your changes

You can run the test suite with the latest version of all dependencies by running the following:

  • Run bundle install if you haven't done so already, or bundle update to update the dependencies
  • Run bundle exec rake to run the tests

The review process

  • I will try to review your pull request as soon as possible but I can make no guarantees. Feel free to ping me now and again.
  • I will probably ask you to rebase your branch on current master at some point during the review process. If you are unsure how to do this, this in-depth guide should help out.
  • If you have any unclear commit messages, work-in-progress commits, or commits that just fix a mistake in a previous commit, I will ask you to clean up the history. Again, the git-rebase guide should help out. Note that I will not squash-merge pull requests, since that results in a loss of history.
  • At the end of the review process I may still choose not to merge your pull request. For example, this could happen if I decide the proposed feature should not be part of GirFFI, or if the technical implementation does not match where I want to go with the architecture of the project.
  • I will generally not merge any pull requests that make the build fail, unless it's very clearly not related to the changes in the pull request.