Skip to content

Commit

Permalink
[DOC]: Added contribution guidlines and community link
Browse files Browse the repository at this point in the history
Closes issue hexya-erp#135
  • Loading branch information
jmungai authored and jmungai committed Nov 28, 2022
1 parent 6dcd5b7 commit 970b595
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,3 +246,14 @@ And the rendered view will be :
<field name="LoginDate"/>
</tree>
```
# Contributing

If you wish to contribute to HEXYA project, you can:
1. Suggest an improvement via opening an issue in this repository or related project addons
2. Proposing a pull request for a feature or bug fix
3. Helping with the documentation of this project.
4. Any other action that may help improve the project further such as marketing campaigns, promoting adoption etc.

For developers, we are always looking for developers to join our community and make the project feature rich. If you are interested in contributing to this project. You can join our [slack channel](https://join.slack.com/t/nuovaareadila-3id2004/shared_invite/zt-1kj6ncmas-TI4DTVaVvHfg1CFCoAm15Q). All issues and feature will be discussed here and approach or design issues addressed.

In addition, you can check the [Design guidelines](doc/design.adoc) and [contribution guide](doc/contribution.adoc) for further information.
36 changes: 36 additions & 0 deletions doc/contribution.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
= Contributing to the project
Author John Mungai
:prewrap!:
:toc:
:sectnums:

== Introduction

The contribution required for the project is mainly in regard to feature standardization. The set of targeted features are mostly to be as close as possible to Odoo framework.
This will enable the team to reliably port all Odoo features into this project while maintaining the system in a workable state. The architecture followed will also be similar to Odoo framework, however deviations from this
framework will be discussed in our developer channel (Refer design guidelines here [doc/design.adoc]).

== Coding standard

For the love of code, we will be following the (Google's coding standard for Golang [https://google.github.io/styleguide/go/]). This will enable the team make code decisions faster and without any friction.

== Git

=== Tags and commit messages
Tags will be used to prefix your commit messages. Tags should be one of the following:

. [FIX] for bug fixes: mostly used in stable version but also valid if you are fixing a recent bug in development version;
. [REF] for refactoring: when a feature is heavily rewritten;
. [ADD] for adding new modules;
. [REM] for removing resources: removing dead code, removing views, removing modules, …;
. [REV] for reverting commits: if a commit causes issues or is not wanted reverting it is done using this tag;
. [MOV] for moving files: use git move and do not change content of moved file otherwise Git may lose track and history of the file; also used when moving code from one file to another;
. [REL] for release commits: new major or minor stable versions;
. [IMP] for improvements: most of the changes done in development version are incremental improvements not related to another tag;
. [MERGE] for merge commits: used in forward port of bug fixes and main commit for a number of commits;
. [I18N] for changes in translation files;
. [DOC] for changes in project or module documentations;




0 comments on commit 970b595

Please sign in to comment.