Skip to content
This repository has been archived by the owner on Sep 2, 2021. It is now read-only.

Latest commit

 

History

History
35 lines (30 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

35 lines (30 loc) · 2.47 KB

Thanks for contributing to MultilingualPress (MLP)—you rock!

MultilingualPress

Getting Started

  • Make sure you have a GitHub account.
  • See if your issue has been discussed (or even fixed) earlier. You can search for existing issues.
  • Assuming it does not already exist, create a new issue.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository on GitHub.

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on the master branch:
      • git checkout -b issue/%YOUR-ISSUE-NUMBER%_%DESCRIPTIVE-TITLE% master
      • a good example is issue/118_html_lang_attribute
    • Please avoid working directly on the master branch.
  • Make commits of logical units.
  • Make sure your commit messages are helpful.
  • If you want to work on assets, find all relevant files in the resources folder. There you can initialize grunt with npm install and then grunt watch your changes.

Submitting Changes

  • Push your changes to the according topic branch in your fork of the repository.
  • Create a pull request to our repository.
  • Wait for feedback. The MLP team looks at pull requests on a regular basis.

License

By contributing code to MultilingualPress, you grant its use under the GNU General Public License v3.