kotovalexarian-likes-github/middleman--middleman
1
0
Fork 0
mirror of https://github.com/middleman/middleman.git synced 2022-11-09 12:20:27 -05:00
Code Releases Activity
middleman--middleman/.github/CONTRIBUTING.md
Paul McMahon 03170316b8
Reference contribution guidelines in README (#2336) 
Information is duplicated between the two. I think it is simpler to keep
the README focused on a Middleman user's perspective, whereas
CONTRIBUTING.md can focus on a contributor's perspective.

My motivation for this is that I'd like to later add more extensive
documentation about testing Middleman from a contributor's perspective,
but doing this in the README seemed like it would bloat it too much.
2020-06-09 10:36:38 -07:00

2.3 KiB
Raw Permalink Blame History

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code ( no patch is too small : fix typos, add comments, clean up inconsistent whitespace )
  • by refactoring code
  • by closing issues
  • by reviewing patches

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

WE DO NOT ACCEPT NEW FEATURES FOR THE V3 BRANCH ANYMORE

  1. Fork the repository.
  2. Create a topic branch. git checkout -b local_topic_branch
  3. Add specs for your unimplemented feature or bug fix.
  4. Run the tests. If your specs pass, return to step 3.
  5. Implement your feature or bug fix.
  6. Run the tests. If your specs fail, return to step 5.
  7. Add, commit, and push your changes. To push your topic branch use git push -u origin local_topic_branch.
  8. Submit a pull request.

Testing

Internally, we test Middleman using a combination of Cucumber and RSpec. Cucumber is used for specifying behavior a high level, whereas RSpec is used for testing components in isolation.

Running the tests

  1. Checkout Repository: git clone https://github.com/middleman/middleman.git
  2. Install Bundler: gem install bundler
  3. Run bundle install inside the project root to install the gem dependencies.
  4. Run test cases: bundle exec rake test