[PATCH 1/3] trace-cruncher: Update CONTRIBUTING.md

* [PATCH 1/3] trace-cruncher: Update CONTRIBUTING.md
@ 2021-08-25  9:44 Yordan Karadzhov (VMware)
  2021-08-25  9:44 ` [PATCH 2/3] trace-cruncher: Update README.md Yordan Karadzhov (VMware)
  2021-08-25  9:44 ` [PATCH 3/3] trace-cruncher: Fix the copyright notices Yordan Karadzhov (VMware)
  0 siblings, 2 replies; 3+ messages in thread
From: Yordan Karadzhov (VMware) @ 2021-08-25  9:44 UTC (permalink / raw)
  To: linux-trace-devel; +Cc: Yordan Karadzhov (VMware)

Remove the legacy content that came from the template file and make
it provide adequate instruction for contributors.

Signed-off-by: Yordan Karadzhov (VMware) <y.karadz@gmail.com>
---
 CONTRIBUTING.md | 72 +++++++------------------------------------------
 1 file changed, 10 insertions(+), 62 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2f92264..27c7ccb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,77 +2,25 @@
 
 # Contributing to trace-cruncher
 
-The trace-cruncher project team welcomes contributions from the community. Before you start working with trace-cruncher, please
-read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be
-signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on
-as an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).
+The trace-cruncher project team welcomes contributions from the community. All contributions to this repository must be
+signed. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. 
 
-## Contribution Flow
+The development process of trace-cruncher is strongly coupled to the development of the Linux kernel tracing libraries [libtraceevent](https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git), [libtracefs](https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/) and [KernelShark](https://git.kernel.org/pub/scm/utils/trace-cmd/kernel-shark.git/). Because of this reason we adopt and follow the development workflow established by those projects.
 
-This is a rough outline of what a contributor's workflow looks like:
+For contributions to development, please send patches to: linux-trace-devel@vger.kernel.org
 
-- Create a topic branch from where you want to base your work
-- Make commits of logical units
-- Make sure your commit messages are in the proper format (see below)
-- Push your changes to a topic branch in your fork of the repository
-- Submit a pull request
-
-Example:
-
-``` shell
-git remote add upstream https://github.com/vmware/trace-cruncher.git
-git checkout -b my-new-feature master
-git commit -a
-git push origin my-new-feature
-```
-
-### Staying In Sync With Upstream
-
-When your branch gets out of sync with the vmware/master branch, use the following to update:
-
-``` shell
-git checkout my-new-feature
-git fetch -a
-git pull --rebase upstream master
-git push --force-with-lease origin my-new-feature
-```
-
-### Updating pull requests
-
-If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
-existing commits.
-
-If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
-amend the commit.
-
-``` shell
-git add .
-git commit --amend
-git push --force-with-lease origin my-new-feature
-```
-
-If you need to squash changes into an earlier commit, you can use:
-
-``` shell
-git add .
-git commit --fixup <commit>
-git rebase -i --autosquash master
-git push --force-with-lease origin my-new-feature
-```
-
-Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a
-notification when you git push.
+[Subscribe](http://vger.kernel.org/vger-lists.html#linux-trace-devel) / [Archives](https://lore.kernel.org/linux-trace-devel/)
 
 ### Code Style
 
-### Formatting Commit Messages
+The preferred coding style for the project is the [Linux kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html#linux-kernel-coding-style)
 
-We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
+### Formatting Commit Messages
 
-Be sure to include any related GitHub issue references in the commit message.  See
-[GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues
-and commits.
+The project follows the conventions for [submitting patches](https://www.kernel.org/doc/html/v5.4/process/submitting-patches.html)
+as described by the Linux kernel.
 
 ## Reporting Bugs and Creating Issues
+For bug reports and issues, please file it [bugzilla](https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---)
 
 When opening a new issue, try to roughly follow the commit message format conventions above.
-- 
2.30.2


^ permalink raw reply related	[flat|nested] 3+ messages in thread