Guidelines

Guidelines for creating, and contributing to Devies Developments projects.

Project set-up

Every project is different, but here follows a list of things that is great to have in a project:

• README.md
  • Explanation of the project - Why does it exist?
  • Installation guide - How do I run it?
  • Development guide - How do I set up the development environment?
  • A list of used technologies and frameworks present in the project
• CONTRIBUTING.md, can link to this README
• License file LICENSE with the appropriate license
• Master branch protection
  • Enforce reviews before merging a pull request.
• The about section in Github filled in
• Pull request template
• ARCHITECTURE.md, read more here
• Unit tests
• Integration tests

Contributing to a project

We at Devies Development appreciate all forms of contributions, no matter how small! Feel free to open a pull request to solve an issue or ask for help.

Issues in Github are used for our project to track ideas, work, and bugs.

Creating Issues

Structure suggestion:

• Context: explain the conditions which led you to write this issue.

• Problem or idea: the context should lead to something, an idea, or a problem that you’re facing.

• Solution or next step: this is where you move forward. You can engage others (request feedback), assign somebody else to the issue, or simply leave it for further investigation, but you need to propose a next step towards solving the issue.