Skip to content

Commit

Permalink
Fixes for #50, Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Krum Tsvetkov <[email protected]>
  • Loading branch information
krumts committed May 23, 2024
1 parent 6e18324 commit e763885
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 46 deletions.
74 changes: 29 additions & 45 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,50 @@
Contributing to Memory Analyzer
====================

Thanks for your interest in this project.
Thanks for your interest in the Memory Analyzer project!

Project description:
--------------------

The Eclipse Memory Analyzer is a fast and feature-rich Java heap dump analyzer that helps you find memory leaks and reduce memory consumption.

- <http://eclipse.dev/mat/>
- Memory Analyzer web site: <http://eclipse.dev/mat/>

Source
------

The Memory Analyzer code is stored in a git repository on Github.
The Memory Analyzer code is hosted on Github.

<https://github.com/eclipse-mat/mat>

You can contribute bugfixes and new features by sending pull requests through GitHub.

Developer resources:
Developer resources
--------------------

Information regarding source code management, builds, coding standards, and more.
Information regarding setting up you development environment, building MAT, running tests, coding standards, and more.

- [Contributor Reference](dev-doc/Contributor_Reference.md)
- [Developers](https://www.eclipse.org/mat/developers/) area on the MAT web site
- [MemoryAnalyzer/Contributor Reference](http://wiki.eclipse.org/index.php?title=MemoryAnalyzer/Contributor_Reference) Wiki pages


Contributing a patch
Contributing a change
--------------------

## Legal

In order for your contribution to be accepted, it must comply with the Eclipse
Foundation IP policy.

Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).

1. Sign the [Eclipse ECA](http://www.eclipse.org/legal/ECA.php)
1. Register for an Eclipse Foundation User ID. You can register [here](https://accounts.eclipse.org/user/register).
2. Log into the [Accounts Portal](https://accounts.eclipse.org/), and click on the '[Eclipse Contributor Agreement](https://accounts.eclipse.org/user/eca)' link.
2. Go to your [account settings](https://accounts.eclipse.org/user/edit) and add your GitHub username to your account.
3. Make sure that you _sign-off_ your Git commits in the following format:
``` Signed-off-by: John Smith <[email protected]> ``` This is usually at the bottom of the commit message. You can automate this by adding the '-s' flag when you make the commits. e.g. ```git commit -s -m "Adding a cool feature"```
4. Ensure that the email address that you make your commits with is the same one you used to sign up to the Eclipse Foundation website with.

## Contributing a change

1. [Fork the repository on GitHub](https://github.com/eclipse-mat/mat/fork)
2. Clone the forked repository onto your computer: ``` git clone
https://github.com/<your username>/mat.git ```
3. If you are adding a new feature, then create a new branch from the latest
```develop``` branch with ```git checkout -b YOUR_BRANCH_NAME
origin/develop```
4. If you are fixing a bug, then create a new branch from the latest
```fixes``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/fixes```
5. Make your changes
6. Ensure that all new and existing tests pass.
7. Commit the changes into the branch: ``` git commit -s ``` Make sure that
- The section "Eclipse Contributor Agreement" below describes the formal requirements for contributing to an Eclipse project
- [Fork the MAT repository on GitHub](https://github.com/eclipse-mat/mat/fork)
- Clone the forked repository onto your computer: ``` git clone https://github.com/<your username>/mat.git ```
and checkout the ```master``` branch
- See [MemoryAnalyzer/Contributor Reference](dev-doc/Contributor_Reference.md) for instructions on setting up a local development environment for MAT
- Make your changes
- Ensure that all new and existing tests pass.
- Commit the changes into the branch: ``` git commit -s ``` Make sure that
your commit message is meaningful and describes your changes correctly.
8. If you have a lot of commits for the change, squash them into a single / few
- If you have a lot of commits for the change, squash them into a single / few
commits.
9. Push the changes in your branch to your forked repository.
10. Finally, go to
- Push the changes in your branch to your forked repository.
- Consider opening an issue on the MAT project to discuss your contribution
- Finally, go to
[https://github.com/eclipse-mat/mat](https://github.com/eclipse-mat/mat)
and create a pull request from your "YOUR_BRANCH_NAME" branch to the
```develop``` or ```fixes``` branch as appropriate to request review and
merge of the commits in your pushed branch.
```master``` branch to request review.

What happens next depends on the content of the patch. If it is 100% authored
by the contributor and is less than 1000 lines (and meets the needs of the
Expand All @@ -78,9 +55,16 @@ are required. These are detailed in the
Eclipse Contributor Agreement:
------------------------------

In order to contribute to the project you need to electronically sign the [Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php) (ECA). Find more information in the ECA [FAQ](https://www.eclipse.org/legal/ecafaq.php).
In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy.
- You need to electronically sign the [Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php) (ECA). Find more information in the ECA [FAQ](https://www.eclipse.org/legal/ecafaq.php).
- Register for an Eclipse Foundation User ID. You can register [here](https://accounts.eclipse.org/user/register).
- Log into the [Accounts Portal](https://accounts.eclipse.org/), and click on the '[Eclipse Contributor Agreement](https://accounts.eclipse.org/user/eca)' link.
- Go to your [account settings](https://accounts.eclipse.org/user/edit) and add your GitHub username to your account.
- Make sure that you _sign-off_ your Git commits in the following format:
``` Signed-off-by: John Smith <[email protected]> ``` This is usually at the bottom of the commit message. You can automate this by adding the '-s' flag when you make the commits. e.g. ```git commit -s -m "Adding a cool feature"```
- Ensure that the email address that you make your commits with is the same one you used to sign up to the Eclipse Foundation website with.

- <https://www.eclipse.org/legal/ECA.php>
For more details see [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).

Contact:
--------
Expand Down
2 changes: 1 addition & 1 deletion dev-doc/Contributor_Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ See [Building MAT with Maven](Building_MAT_with_Maven.md) if you want to produce
The unit tests a placed in the ''org.eclipse.mat.tests'' project. Execute the tests by right-clicking on the project and choose ''Run As... -&gt; JUnit Plug-in Test''.

The following VM arguments are required in the run configuration for the JUnit Plug-in Test:
''-Xmx850m -ea --add-exports java.base/jdk.internal.org.objectweb.asm=ALL-UNNAMED''
```-Xmx850m -ea --add-exports java.base/jdk.internal.org.objectweb.asm=ALL-UNNAMED```

For the ''org.eclipse.mat.rcp.tests'' project install SWTBot - API from [https://www.eclipse.org/swtbot/].

Expand Down

0 comments on commit e763885

Please sign in to comment.