update CONTRIBUTING.md with MTA-Agent project info
Browse files- CONTRIBUTING.md +7 -23
CONTRIBUTING.md
CHANGED
|
@@ -1,46 +1,31 @@
|
|
| 1 |
-
|
| 2 |
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to {PROJECT}. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes.
|
| 6 |
|
| 7 |
# Governance Model
|
| 8 |
-
> Pick the most appropriate one
|
| 9 |
-
|
| 10 |
-
## Community Based
|
| 11 |
-
|
| 12 |
-
The intent and goal of open sourcing this project is to increase the contributor and user base. The governance model is one where new project leads (`admins`) will be added to the project based on their contributions and efforts, a so-called "do-acracy" or "meritocracy" similar to that used by all Apache Software Foundation projects.
|
| 13 |
-
|
| 14 |
-
> or
|
| 15 |
|
| 16 |
## Salesforce Sponsored
|
| 17 |
|
| 18 |
The intent and goal of open sourcing this project is to increase the contributor and user base. However, only Salesforce employees will be given `admin` rights and will be the final arbitrars of what contributions are accepted or not.
|
| 19 |
|
| 20 |
-
> or
|
| 21 |
-
|
| 22 |
-
## Published but not supported
|
| 23 |
-
|
| 24 |
-
The intent and goal of open sourcing this project is because it may contain useful or interesting code/concepts that we wish to share with the larger open source community. Although occasional work may be done on it, we will not be looking for or soliciting contributions.
|
| 25 |
-
|
| 26 |
# Getting started
|
| 27 |
|
| 28 |
-
Please
|
| 29 |
|
| 30 |
# Issues, requests & ideas
|
| 31 |
|
| 32 |
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
|
| 33 |
|
| 34 |
### Bug Reports and Fixes
|
| 35 |
-
- If you find a bug, please search for it in the [Issues](https://github.com/
|
| 36 |
-
[create a new issue](https://github.com/
|
| 37 |
be reviewed.
|
| 38 |
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
|
| 39 |
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
|
| 40 |
- Include tests that isolate the bug and verifies that it was fixed.
|
| 41 |
|
| 42 |
### New Features
|
| 43 |
-
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/
|
| 44 |
- Issues that have been identified as a feature request will be labelled `enhancement`.
|
| 45 |
- If you'd like to implement the new feature, please wait for feedback from the project
|
| 46 |
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
|
|
@@ -51,7 +36,7 @@ Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
|
|
| 51 |
alternative implementation of something that may have advantages over the way its currently
|
| 52 |
done, or you have any other change, we would be happy to hear about it!
|
| 53 |
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
|
| 54 |
-
- If not, [open an Issue](https://github.com/
|
| 55 |
|
| 56 |
If you're new to our project and looking for some way to make your first contribution, look for
|
| 57 |
Issues labelled `good first contribution`.
|
|
@@ -66,7 +51,6 @@ Issues labelled `good first contribution`.
|
|
| 66 |
- [x] Tests
|
| 67 |
- The test suite, if provided, must be complete and pass
|
| 68 |
- Increase code coverage, not versa.
|
| 69 |
-
- Use any of our testkits that contains a bunch of testing facilities you would need. For example: `import com.salesforce.op.test._` and borrow inspiration from existing tests.
|
| 70 |
- [x] Dependencies
|
| 71 |
- Minimize number of dependencies.
|
| 72 |
- Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
|
|
|
|
| 1 |
+
# Contributing Guide For MTA-Agent
|
| 2 |
|
| 3 |
+
This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to MTA-Agent. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes.
|
|
|
|
|
|
|
| 4 |
|
| 5 |
# Governance Model
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 6 |
|
| 7 |
## Salesforce Sponsored
|
| 8 |
|
| 9 |
The intent and goal of open sourcing this project is to increase the contributor and user base. However, only Salesforce employees will be given `admin` rights and will be the final arbitrars of what contributions are accepted or not.
|
| 10 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
# Getting started
|
| 12 |
|
| 13 |
+
Please open a [GitHub Issue](https://github.com/SalesforceAIResearch/MTA-Agent/issues) to discuss ideas, report bugs, or request features. Also please make sure to take a look at the project [README](README.md) to get started.
|
| 14 |
|
| 15 |
# Issues, requests & ideas
|
| 16 |
|
| 17 |
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
|
| 18 |
|
| 19 |
### Bug Reports and Fixes
|
| 20 |
+
- If you find a bug, please search for it in the [Issues](https://github.com/SalesforceAIResearch/MTA-Agent/issues), and if it isn't already tracked,
|
| 21 |
+
[create a new issue](https://github.com/SalesforceAIResearch/MTA-Agent/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
|
| 22 |
be reviewed.
|
| 23 |
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
|
| 24 |
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
|
| 25 |
- Include tests that isolate the bug and verifies that it was fixed.
|
| 26 |
|
| 27 |
### New Features
|
| 28 |
+
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/SalesforceAIResearch/MTA-Agent/issues/new).
|
| 29 |
- Issues that have been identified as a feature request will be labelled `enhancement`.
|
| 30 |
- If you'd like to implement the new feature, please wait for feedback from the project
|
| 31 |
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
|
|
|
|
| 36 |
alternative implementation of something that may have advantages over the way its currently
|
| 37 |
done, or you have any other change, we would be happy to hear about it!
|
| 38 |
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
|
| 39 |
+
- If not, [open an Issue](https://github.com/SalesforceAIResearch/MTA-Agent/issues/new) to discuss the idea first.
|
| 40 |
|
| 41 |
If you're new to our project and looking for some way to make your first contribution, look for
|
| 42 |
Issues labelled `good first contribution`.
|
|
|
|
| 51 |
- [x] Tests
|
| 52 |
- The test suite, if provided, must be complete and pass
|
| 53 |
- Increase code coverage, not versa.
|
|
|
|
| 54 |
- [x] Dependencies
|
| 55 |
- Minimize number of dependencies.
|
| 56 |
- Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
|