CONTRIBUTING.md

Contributing Guide to PHP Resources

We love contributors and people willing to help.

How Can You Help?

• Report issues
• Fix typos and grammar
• Add new content
• Improve existing chapters

Contributing Procedure

Below is described procedure for contributing to this repository in particular and some extra information about it.

• Fork this repository over GitHub

• Create a separate branch for instance patch-1 so you will not need to rebase your fork if your master branch is merged

  git clone [email protected]:your_username/php-resources
  cd php-resources
  git checkout -b patch-1

• Make changes, commit them and push to your fork

  git add .
  git commit -m "Fix typo in the FAQ"
  git push origin patch-1

• Open a pull request

Style Guide

• This repository uses Markdown syntax and follows cirosantilli/markdown-style-guide style guide.

• Code examples follow PSR-1, PSR-2 and extended code style guide proposal.

• The preferred spelling of English words is the American English (e.g. behavior, not behaviour).

• Titles have capitalized certain words such as nouns, pronouns, adjectives, verbs, adverbs, and subordinate conjunctions.

• Use gender-neutral language (instead of he or she use they, them, their, theirs, themselves).

• Use second person point of view (instead of I and we, use you). Avoid nosism.

Images

Some images are created with the draw.io tool. They are also located in a separate repository.

YAML Front Matter

Contents include the YAML front matter blocks with the following parameters to define extra content information:

• permalink - URL path of the content
• title
• image - image used for open graph
• updated - last contextual change date
• redirect_from - 301 redirects of previous URLs

GitHub Issues Labels

Labels are used to organize issues and pull requests into manageable categories. The following labels are used:

• duplicate - Attached when the same issue or pull request already exists.
• easy pick - Requires simple work.
• enhancement - New feature.
• faq - Attached for FAQ section content.
• hacktoberfest - Attached for open source Hacktoberfest event.
• invalid - Attached when
• needs review - Attached when further review is required.
• new content - For new articles or new FAQs.
• question - Attached for questions or discussions.
• wontfix - Attached when decided that issue will not be fixed.

License

By contributing to this repository you agree to share knowledge under the Creative Commons Attribution-ShareAlike 4.0 International and code under the public domain.

Release Process

(For repository maintainers)

This repository follows semantic versioning. When new changes are added, a new version (e.g. 1.x.y) is released by the following release process:

1. Changelog update:

Create an entry in CHANGELOG.md describing all the changes from previous release.

2. Tag new release:

Tag a new version on GitHub, and attach necessary binary file(s).

3. Update the git module for the GitHub page.