Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 3.09 KB

contributing.md

File metadata and controls

42 lines (27 loc) · 3.09 KB
Raw

PHLASK Contributing guidelines

First off, thank you for considering contributing to PHLASK App. It's people like you that make PHLASK such a great tool. Following these guidelines helps to communicate that you respect everyone's time managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Code of Conduct

We follow the Code for Philly COC listed here.

Your First Contribution

Unsure where to begin contributing to PHLASK? It always best to attend to for Philly Hack Nights to general understanding of what's needed. Most issues are created and assigned at Hack Nights. If you need more help on how to contribute to open source. You can learn how from this free series, How to Contribute to an Open Source Project on GitHub

  1. Create your own fork of the code: https://help.github.com/en/github/getting-started-with-github/fork-a-repo
  2. Develop your changes in your fork (See the README to view how you can test your changes locally)
    • If you are new to Git & GitHub, we would recommend Sections 1.5, 1.6, and Chapter 2 of the online Git Book
    • If you have any questions about the development workflow, feel free to ask us for help via the Code For Philly Slack #phlask channel (Keeping the Code of Conduct in mind)
  3. If you like the change and think the project could use it, open a Pull Request: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork

How to report a bug

If you find a security vulnerability, do NOT open an issue. Message Billy, Taylor, Khalil, Gabriel on the Code For Philly Slack #phlask Channel (or directly) instead.

For non-security bug reports, open a GitHub issue and choose the Bug Report template. Follow the template, where possible, to provide the necessary information to address the bug.

How to suggest a feature or enhancement

Have an idea for a new feature or an enhancement to existing functionality? Open a GitHub issue and select the Feature Request template. We use GH issues to plan for things to work on as well as track ongoing work on our project board.

Code review process

The core team look at Pull Requests every HackNight for major changes and features. For smaller changes they will be reviewed ASAP.

Example of smaller changes

  • Spelling / grammar fixes
  • Typo correction, white space and formatting changes
  • Comment clean up
  • Bug fixes that change default return values or error codes stored in constants
  • Adding logging messages or debugging output
  • Changes to ‘metadata’ files like Gemfile, .gitignore, build scripts, etc.
  • Moving source files from one directory or package to another