Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (18 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

32 lines (18 loc) · 2.09 KB

Contributing

Welcome to Programaker! We're happy that you are considering contributing, only that way we can drive this project forwards. Let's check some things that you might want to consider.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. This way we make sure everyone's effort fit on the general evolution of the project.

Of course, you can ignore this and just send a Merge Request right away for trivial changes like typos, use your judgement and feel free to propose changes to this document.

How to open an Issue

  1. Go to the project's issue tracker.
  2. Select the Bug template for bug reports or New Feature for feature proposals.
  3. Give the issue an appropriate title.
  4. Fill the sections on the issue description.
  5. Submit the issue

How to develop a new feature or fix

  1. Open an issue proposing the feature/fix. Alternatively send a comment to one where it's proposed but no one assigned asking for clarifications.
  2. After a goal or design has been agreed, fork the repository. You can git clone your fork and develop on there. Consider creating a new branch on your local clone for this development, if you were developing a "Dark mode theme", you could create a new branch with git checkout -b dark-mode-theme.
  3. Develop the feature or fix.
  4. After the development is completed, commit and push the changes.
  5. Open a Merge Request, select your repository and branch on the source branch column and programaker-project/programaker-core and develop on the target branch.

With these, your feature or fix is sent for review. We'll do our best to answer as soon as possible, but keep in mind that in some cases it might take some time.

Thanks for your help!