Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 2.92 KB

CONTRIBUTING.en.md

File metadata and controls

57 lines (35 loc) · 2.92 KB

How to contribute to PUG-PE Meetup Cookbook?

First, thank you so much for thinking about contributing! 😄😄

This document presents a set of guidelines for contributing to this project. These guidelines aren't exactly rules, but following them helps everyone to be on the same page. Feel free to submit a pull request for this document. In general, use common sense.

Code of conduct

This project and everyone participating in it are subjected to the code of conduct. By participating you are expected to be following it as well.

How can I contribute?

Suggesting improvements

Before suggesting, please make sure the same idea has not been suggested before. If your idea has been suggested, be sure to interact with the issue and help evolve the idea.

How to submit a good improvement suggestion?

Improvements are presented as Github Issues.

  • Use a clear and descriptive title;
  • Provide a detailed description of the suggestion;
  • Explain why this improvement is useful;
  • Describe a before and after, if applicable;
  • Provide examples, if applicable.

Implementing Improvements

After taking a look at the improvements already suggested, did you find that you could implement some of them? You are in the right section!

Creating Pull Requests

With the Pull Requests(or PR) you can integrate what you have developed with our project.

For this, please follow the steps below to evaluate your contribution:

  1. Follow the instructions for the pull requests template when creating it;
  2. Follow the style guides;

Even if the above prerequisites are followed, this does not mean that project maintainers cannot request additions to the pull request, clarification of information, changes to some sections, etc., before the contribution is accepted.

Style guides

commit messages of git

  • Use Affirmative Imperative on second person ("Add Contribution Guides ..." not "Adding Contribution Guides ...")
  • Title (first line) must be 50 characters or less
    • Write objective commit message about what that commit changes in the project.
    • Try to answer "What does this commit do?";
  • If commit is described, leave the second line blank;
  • Add a description to the commit beginning from the third line, with 72 characters or less per line;
    • When asking yourself if a description is required for commit, ask yourself if anyone wants to investigate "why this change has been introduced" will only be possible by the title and content of commit;
    • Add a description that answers the question "Why is this commit necessary?";
  • Refer to issues or pull requests at the end of the message;

Thanks! ❤️ ❤️ ❤️