A story telling chess experience.
To contribute to the projekt, you will need to create a new branch
The branch will follow the folowing naming scheme:
type-issueNum-shortDescription
For example if you are going to implemnt the requested feature from issue #1 you would then create the branch:
feature-1-implement-chess-piece-enum
there ar multiple diffrent types that can be used, but here is a list of the most common:
bug
lable uses the typebug
documentation
label uses the typedoc
needed
label uses the typemvp
as in Minimum Viable Productenhancement
label uses the typefeature
Remember to use descriptive names for you commits whilst implementing. We want to avoid using commits that just say fixed
or done
.
Instead use sometinh more like fixed issue with ...
or Implemented feature ...
if the commits are on a small task.
If you are working on a lareger task remeber to commit during your way and use short descriptions on what the commit did.
When the issue has been solved in your local branch create a PR (PR is short for pull request) to merge your branch into main. This will (if tests pass) allow you to change the main-branch of repo so other contributers can pull your new changes. We will use normal merging of commits so we can delete merged branches.