Skip to content

Latest commit

 

History

History
executable file
·
129 lines (93 loc) · 5.91 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
129 lines (93 loc) · 5.91 KB
Raw

Contributing to doesangue.me

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

🍰 First off, thanks for taking you precious time to contribute. 👍 The following is a set of guidelines for Contributing to Doe Sangue.me and it's projects/apps, which are in the Doe Sangue on Github. These are just guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a Pull Request.

Table of contents

What to know before start?

Getting started

Contributions are always welcome and will be fully credited.

We accept contributions via Pull Requests via Github and/or tests in our doesangue.me demo app.

Search if the issue/bug you are trying to resolve wasn't already solved... Try to search issues in 💪 #wontfix label or 🐛 #bug. If you prefer to search for Pull Requests check 💪 #wontfix.

If you get a new idea or want to add a new feature please before you create a new Pull Requests open an Issue talking about it.

How?

  • 1 Fork the project.
  • 2 Create your bugfix/feature branch and your (commented) code.

Note: Consider to naming your branch based on feature you'll work. Like in example:

git checkout -b my-new-feature development

where development is the branch where the my-new-feature will be based.

  • 3 Create unit tests for your feature/code:
  • 3.1 Run php artisan make:test --unit ClassnameTest (don't forget the Test suffix) and write your test inside the class.
  • 3.2 Run vendor/bin/phpunit to make sure everything works as well (new and old tests).
  • 4 Commit your changes (your feature and tests) and push to your branch.
  • 5 Run the following to make sure your fork is updated with our latest changes.
git remote add upstream git@github.com:doesangueorg/doesangue-core.git
git checkout development
git pull upstream development

Then update your feature branch from your local copy of development, and push it!

git checkout my-new-feature
git rebase development
git push --set-upstream origin my-new-feature

Finally, go to Github and make a Pull Request 🍰 🍰 🍰

Pull Requests

  • Use the PSR-2 Coding Standard. The easiest way to apply the conventions is to install the PHP Code Sniffer.

  • Add tests! Your pull request won't be accepted if it doesn't have tests (or if it doesn't passes).

  • Document any change in behavior. Make sure the README.md, CONTRIBUTORS.md and any other relevant documentation are kept up-to-date.

  • Don't worry about updating CHANGELOG.md. The package administrator will handle updating those when new releases are created.

Styleguide

Note: More details about styleguide needed here.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")

  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")

  • Limit the first line to 72 characters or less

  • Reference issues and pull requests liberally

  • When only changing documentation, include [ci skip] in the commit description

  • Consider starting the commit message with an applicable emoji:

Emoji Code Description
🎨 :art: when improving the format/structure of the code
🐎 :racehorse: when improving performance
📝 :memo: when writing docs
💪 :muscle: when adding new features/functions
🐛 :bug: when fixing a bug
🔥 :fire: when removing code or files
💚 :green_heart: when fixing the CI build
✅ :white_check_mark: when adding tests
🔒 :lock: when dealing with security
⬆️ :arrow_up: when upgrading dependencies
⬇️ :arrow_down: when downgrading dependencies
👕 :shirt: when removing linter warnings

Contributors

After you have created/added your features, changes don't forget to add yourself to our contributors list following the next steps:

  • Install all-contributors dependency
 npm install
 npm run add YOURNAME category1 category2

Or run only the npm run add without arguments and will be open and interactive prompt

  • Then update the list with you name
 npm run generate

TO-DO

  • Add the styleguide.
  • Add the Pull Requests and Issue templates
  • Add environment/dev requirements

Chat

if you prefer to open a chat with other members/developers join us on Gitter and/or Slack.

Back to top