search

pamaxie / --OLD--Pamaxie

Worker "clients" for analyzing media content. Pamaxie is a Natural Learning API for accessing several Neural Networks and hand-crafted algorithms for moderating content on platforms.
https://pamaxie.com
Apache License 2.0
2 stars 2 forks source link

Create Contribution Guidelines #13

Open ghost opened 3 years ago

ghost commented 3 years ago

We need to create Contribution guidelines

ghost commented 3 years ago

The contribution guidelines should include how to contribute to the project, this means how we expect contributions to be done. Even core contributors are asked to stick to them whenever possible.

They should include: Only work on issues that you know you can fix or are willing to do the research to fix. Only work on problems that are documented. If you find a new issue create an issue first. Core contributors will validate the issue and then say if it's worth working on and if it should be worked on at all.

Planning is key. Some issues require that. If something is flagged as a "Complex Problem" it usually requires planning and we expect contributors to have done that planning and explain their train of thought as a comment in the issue. We will then agree or disagree with the implementation. After that, a contribution can be done.

These are all my opinions on how the contribution guidelines should roughly look. Obviously, they should also follow the basic code guides like separation of concern and kiss.

ghost commented 3 years ago

We also require a standardization of formatting (preferably Spacious Formatting) and everything that is implemented needs to be documented. Also, peer reviews should be considered.

ghost commented 3 years ago

Test methods should be implemented for all newly added functions that are facing outwards, especially if they are Accessible through the API or website

PKoldborg commented 3 years ago

Question about Commit Messages, do we want any format? Currently we will have,

ISSUE Comment

Are there any commit format we want to follow? Or just any suggestions?

ghost commented 3 years ago

For commit messages we want the Issue Number as well as a short sumup of the changes

ghost commented 3 years ago

@PKoldborg how is this going so far? Are we completed or does this still need stuff?

PKoldborg commented 3 years ago

@LeechFilcher stuff is still needed. Mostly information on how people can contribute, and a bit more about what we expect the person to do when contributing.

PKoldborg commented 3 years ago

Contribution Guideline have been finished.

This issue will be staying open for a few weeks (estimated: 1-3 weeks), just to have more time going through it and see if more should be added, or changed.