Skip to content

Latest commit

 

History

History
75 lines (60 loc) · 3.6 KB

CONTRIBUTING.md

File metadata and controls

75 lines (60 loc) · 3.6 KB
Raw

Contributing to Publify

We welcome contributions to Publify. 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 us to figure out what's going on. If you miss any of these points we 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, including the URLs of the pages you visited
  • Describe what you expected to happen
  • Describe what happened instead, including any relevant output, error logs or screenshots
  • State the version of Publify you are using
  • Use code blocks to format any code and output in your ticket to make it readable.

Pull Requests

We welcome pull requests. Please check first if the problem you're solving is fixed in master, or if the desired feature is already in development. Before starting a large feature, please open a ticket first so we can discuss 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

To run the tests suite for TODO a particular version of Rails, use appraisal. For example, to run the specs with Rails 6.1, run appraisal rails_6_1 rake. See appraisal's documentation for details.

The review process

  • We will try to review your pull request as soon as possible but we can make no guarantees. Feel free to ping us 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, we will ask you to clean up the history. Again, the git-rebase guide should help out. Note that we will not squash-merge pull requests, since that results in a loss of history.
  • At the end of the review process we may still choose not to merge your pull request. For example, this could happen if we decide the proposed feature should not be part of Publify, or if the technical implementation does not match where I want to go with the architecture of the project.
  • We 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.