Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

81 lines (58 loc) · 2.49 KB
Raw

Contributing

When contributing to Miroha, please first discuss the change you wish to make via GitHub Issues before making the change.

Please note we have a code of conduct, which you should follow it in all your interactions with the project.

Development Environment

Requirements

You need the following software installed for local development:

Setup

To get started, clone the repository.

git clone https://github.com/tristandunn/miroha

Install the dependencies and setup the database.

bin/setup

You can verify everything is installed and setup correctly by running the check Rake task to run the tests and lint the code.

bundle exec rake check

You can run the application using Foreman and a development Procfile.

# Install Foreman if you haven't before.
gem install foreman

# Run with the development `Procfile` option.
foreman start -f Procfile.dev

Issues and Feature Requests

You've found a bug in the source code, a mistake in the documentation, or maybe you'd like a new feature? You can help by submitting an issue to GitHub Issues. Before you create an issue, make sure you search the archive, maybe your question was already answered.

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible.
  • Unique. Do not duplicate existing opened issues.
  • Scoped. Limit each issue to a single bug report.

Pull Requests

  1. Search our repository for open or closed pull requests that relates to your submission. You don't want to duplicate effort.
  2. Fork the project.
  3. Create your feature branch. (git switch -c add-new-feature)
  4. Commit your changes. (git commit -m "Add a new feature.")
  5. Push to the branch. (git push origin add-new-feature)
  6. Open a pull request, providing details to the template where relevant.

When you're writing a commit message, try to summarize the changes into one sentence on the first line. If a more details are helpful, provide them in paragraphs below the first line.