Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.71 KB

Contributing to MyPal

If you would like to contribute to the project, you can do so through our preferred and detailed contribution workflow When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.

Please note we have a code of conduct, please follow it in all your interactions with the project.


Run locally:

cd client
npm install
npm start

Reporting issues & features requests

If you notice any bugs in the project, see some code that can be improved, or have features you would like to be added, please create a bug report or a feature request!

If you want to open a PR that fixes a bug or adds a feature, then it is definitely appreciated if an issue has been created before-hand so it can be discussed first.

Working on issues

Please feel free to take on any issue that's currently open. Feel free to resolve any issue that you would enjoy working on even if it happens to be a low priority.

Submitting a PR

  • For every PR there should be an accompanying issue which the PR solves
  • The PR itself should only contain code which is the solution for the given issue
  • If you are a first time contributor check if there is a good first issue for you

Contribution steps

  1. Fork this repository to your own repositiry.
  2. Clone the forked repositiry to your local machine.
  3. Create your feature branch: git checkout -b my-new-feature
  4. Run the application locally and make changes to the project.
  5. Commit your changes(see our preferred format here): git commit -m 'Add some feature'
  6. Push to the branch: git push origin my-new-feature
  7. Submit a pull request :D



Commit Message format:

commit messages:
feat: The new feature you are adding to MyPal
fix: A bug fix
style: Feature and updates related to styling
refactor: Refactoring a specific section of the codebase
test: Everything related to testing
docs: Everything related to documentation

Example commit message:
feat: added report confessions option

Financial contributions

We also welcome financial contributions. It helps us to grow better and faster.

Community:

Join the dev community for contributing to the project https://discord.gg/CzvcuUdx


License

By contributing your code, you agree to license your contribution under the terms of the MIT license. All files are released with the MIT license.