Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

59 lines (38 loc) · 2.27 KB

How to contribute 📓

🔥🎉 Thanks for taking the time to contribute to this project! 🎉🔥

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this project. In return, we should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Development Process

Please consider the following guidelines:

1. Clone the repo:

git clone [email protected]:Raise-the-Voices/marturia.git

2. Set up your development environment

3. Make your changes in a new git branch:

Following this Git branch naming conventions:

    1-) bugfix/description
    2-) features/feature-name

4. Commit your changes using a descriptive commit message:

Following this commit message conventions:

  The header is mandatory.

  - Any line of the commit message cannot be longer than 72 characters!
  - Use the present tense ("Add feature" not "Added feature")
  - Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  - No dot (.) at the end
  - Don't capitalize the first letter

  Samples:

  docs(changelog): update changelog to beta.5
  fix(release): need to depend on latest rxjs and zone.js

  Type
  Must be one of the following:

  - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  - ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
  - docs: Documentation only changes
  - feat: A new feature
  - fix: A bug fix
  - perf: A code change that improves performance
  - refactor: A code change that neither fixes a bug nor adds a feature
  - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  - test: Adding missing tests or correcting existing tests

5. Submit a pull request with your changes and request a code review from at least two(2) members

Community

We also have Slack chat team. If you're interested in following along with the development process or have questions, feel free to write an email to [email protected] and request an invitation.

Thanks.