Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (42 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 3.16 KB

Contributing to Baaja

First off, thanks for taking the time to contribute! This is set of simple guidelines for contributing to Baaja project. Our main goal is to have fun and try something interesting in modern tech stack. Our second goal is to grow as professionals. And the last one - is to get working tool that we could use in our Community.

What should I know before I get started?

Please get familiar with the idea of this project to be on the same side with us:

Project Scope and Vision

Architecture and other docs

Join Telegram Chat

When contributing to this repository, please first indicate you intention in the Telegram Chat to make sure that nobody else is working on the same story. Then please assign corresponding ticket to you and move it 'In Progress' on our Trello Board so that we track our progress and do not take the same tasks simultaneously.

Please note we DO NOT have a code of conduct, and hope we never need it.

Pull Request Process

Pull requests generally

  1. The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests.
  2. The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
  3. Reference Trello ticket (number and name) in the title of Pull Request
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Submitting a pull request via Git command line

  1. Fork the project by clicking "Fork" in the top right corner of Baaja.
  2. Clone the repository locally git clone https://github.com/<you-username>/baaja.
  3. Create a new, descriptively named branch to contain your change ( git checkout -b my-awesome-feature ).
  4. Hack away, add tests. Not necessarily in that order.
  5. Make sure everything still passes by running tests (see the README_jhipster)
  6. Push the branch up ( git push origin my-awesome-feature ).
  7. Create a pull request by visiting https://github.com/<your-username>/baaja and following the instructions at the top of the screen.

Style Guide

Git Commit Messages

  • Reference Trello ticket (number and name) in the title of commit message
  • Brifly describe changes that was done in this commit
  • Keep your description short and meaningful
  • When only changing documentation, include [ci skip] in the commit title

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members