[incubator-devlake] branch main updated: New contributors guide to backend development (#2125)

[kl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git


The following commit(s) were added to refs/heads/main by this push:
     new 3b377822 New contributors guide to backend development (#2125)
3b377822 is described below

commit 3b3778225d9c7afc75e6ad38441017f7f387740c
Author: Jonathan O'Donnell <jo...@gmail.com>
AuthorDate: Thu Jun 9 11:58:08 2022 -0300

    New contributors guide to backend development (#2125)
    
    * docs: remove maintainers section from contribution.md
    
    * docs: contributing guide updates
    
    * docs: more clear docs on use cases as I develop them
    
    * docs: move contributing.md to docs repo
---
 CONTRIBUTING.md | 64 ---------------------------------------------------------
 README.md       |  4 ++--
 2 files changed, 2 insertions(+), 66 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index 3392e7b8..00000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,64 +0,0 @@
-# Contributing to Lake
-
-👍🎉 First off, thanks for taking the time to contribute! 🎉👍
-
-The following is a set of guidelines for contributing to Lake. These are mostly guidelines, not rules. 
-Use your best judgment, and feel free to propose changes to this document in a pull request.
-
-
-## How Can I Contribute?
-
-1. Reporting bugs by filling out the required issue template and labeling the new issue as 'bug'.
-
-2. Suggesting enhancements.
-
-If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue. 
-This lets us reach an agreement on your proposal before you put significant effort into it.
-
-If you’re only fixing a bug, it’s fine to submit a pull request right away but we still recommend to file an issue detailing what you’re fixing. 
-This is helpful in case we don’t accept that specific fix but want to keep track of the issue.
-
-## Maintainer team @ Merico
-
-Dev Lake is maintained by a group of engineers at Merico, led by [@hezyin](https://github.com/hezyin). 
-We aim to achieve an SLA of 24 hrs for replying to issues.
-
-## Style guides
-
-### Git Commit message
-
-We follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) guidelines.
-
-#### Commit tool
-
-We use https://github.com/lintingzhen/commitizen-go to author our commits.
-
-```sh
-make commit
-```
-
-```
-> lake@1.0.0 commit /home/code/merico-dev/lake
-> cz
-
-cz-cli@4.2.4, cz-conventional-changelog@3.3.0
-
-? Select the type of change that you're committing: (Use arrow keys)
-> feat:     A new feature
-  fix:      A bug fix
-  docs:     Documentation only changes
-  style:    Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-  refactor: A code change that neither fixes a bug nor adds a feature
-  perf:     A code change that improves performance
-  test:     Adding missing tests or correcting existing tests
-(Move up and down to reveal more choices)
-? What is the scope of this change (e.g. component or file name): (press enter to skip)
-? Write a short, imperative tense description of the change (max 93 chars):
- (23) add commit message tool
-? Provide a longer description of the change: (press enter to skip)
-
-? Are there any breaking changes? No
-? Does this change affect any open issues? No
-[chore/commit_message dc34f57] chore: add commit message tool
- 5 files changed, 585 insertions(+), 4 deletions(-)
-```
diff --git a/README.md b/README.md
index b7190eb6..d2c04a6f 100644
--- a/README.md
+++ b/README.md
@@ -67,8 +67,8 @@ This section lists all the documents to help you contribute to the repo.
 - [Architecture](https://devlake.apache.org/docs/Overview/Architecture): Architecture of Apache DevLake
 - [Data Model](https://devlake.apache.org/docs/DataModels/DevLakeDomainLayerSchema): Domain Layer Schema
 - [Add a Plugin](/plugins/README.md): Guide to add a plugin
-- [Add metrics](/plugins/HOW-TO-ADD-METRICS.md): Guide to add metrics in a plugin
-- [Contribution guidelines](CONTRIBUTING.md): Start from here if you want to make contribution
+- [Add Metrics](/plugins/HOW-TO-ADD-METRICS.md): Guide to add metrics in a plugin
+- [Contribution Guidelines](https://devlake.apache.org/community): Start from here if you want to make contribution
 
 
 ## Community