-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #256 from progress/develop
Release 6.0.1
- Loading branch information
Showing
44 changed files
with
1,843 additions
and
874 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,6 @@ | |
.vscode | ||
package-lock.json | ||
tmp | ||
tslint.json | ||
node_modules/ | ||
scratch1/ | ||
scratch2/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,72 +1,85 @@ | ||
Contribute to the JSDO | ||
=== | ||
# Contribute to the JSDO | ||
|
||
*Help us improve the JSDO* | ||
_Help us improve the JSDO_ | ||
|
||
* [Report an Issue](#report-an-issue "Learn how to report an issue") | ||
* [Request a Feature](#request-a-feature "Learn how to submit a feature or improvement request") | ||
* [Contribute to the Code Base](#contribute-to-the-code-base "Learn how to submit your own improvements to the code") | ||
- [Report an Issue](#report-an-issue "Learn how to report an issue") | ||
- [Request a Feature](#request-a-feature "Learn how to submit a feature or improvement request") | ||
- [Contribute to the Code Base](#contribute-to-the-code-base "Learn how to submit your own improvements to the code") | ||
|
||
# Report an Issue | ||
|
||
Report an Issue | ||
=== | ||
If you find a bug in the source code or a mistake in the documentation, you can submit an issue to our <a href="https://github.com/progress/JSDO">GitHub Repository</a>. | ||
Before you submit your issue, search the archive to check if a similar issues has been logged or addressed. This will let us focus on fixing issues and adding new features. | ||
If your issue appears to be a bug, and hasn't been reported, open a new issue. To help us investigate your issue and respond in a timely manner, you can provide is with the following details. | ||
|
||
* **Overview of the issue:** Provide a short description of the visible symptoms. If applicable, include error messages, screen shots, and stack traces. | ||
* **Motivation for or use case:** Let us know how this particular issue affects your work. | ||
* **JSDO version:** List the current version of the JSDO. You can find it by opening any of the src or lib files. | ||
* **System configuration:** Provide us with relevant system configuration information such as operating system, network connection, proxy usage, etc. Let us know if you have been able to reproduce the issue on multiple setups. | ||
* **Steps to reproduce:** If applicable, submit a step-by-step walkthrough of how to reproduce the issue. | ||
* **Related issues:** If you discover a similar issue in our archive, give us a heads up - it might help us identify the culprit. | ||
* **Suggest a fix:** You are welcome to suggest a bug fix or pinpoint the line of code or the commit that you believe has introduced the issue. | ||
- **Overview of the issue:** Provide a short description of the visible symptoms. If applicable, include error messages, screen shots, and stack traces. | ||
- **Motivation for or use case:** Let us know how this particular issue affects your work. | ||
- **JSDO version:** List the current version of the JSDO. You can find it by opening package.json and viewing the version line | ||
- **System configuration:** Provide us with relevant system configuration information such as operating system, network connection, proxy usage, etc. Let us know if you have been able to reproduce the issue on multiple setups. | ||
- **Steps to reproduce:** If applicable, submit a step-by-step walkthrough of how to reproduce the issue. | ||
- **Related issues:** If you discover a similar issue in our archive, give us a heads up - it might help us identify the culprit. | ||
- **Suggest a fix:** You are welcome to suggest a bug fix or pinpoint the line of code or the commit that you believe has introduced the issue. | ||
|
||
[Back to Top][1] | ||
|
||
Request a Feature | ||
=== | ||
You can request a new feature by submitting an issue with the *enhancement* label to our <a href="https://github.com/progress/JSDO">GitHub Repository</a>. | ||
# Request a Feature | ||
|
||
You can request a new feature by submitting an issue with the _enhancement_ label to our <a href="https://github.com/progress/JSDO">GitHub Repository</a>. | ||
If you want to implement a new feature yourself, consider submitting it to the <a href="https://github.com/progress/JSDO">GitHub Repository</a> as a Pull Request. | ||
|
||
[Back to Top][1] | ||
|
||
Contribute to the Code Base | ||
=== | ||
# Contribute to the Code Base | ||
|
||
This project only accepts contributions via Pull Requests and only the project moderators can check in to the main repository branch. | ||
|
||
Before you submit a Pull Request, consider the following guidelines: | ||
* By submitting a pull request, you represent that you have the right to license your contribution to Progress and the community, and agree by submitting the patch that your contributions are licensed under the <a href="https://github.com/progress/JSDO/blob/master/LICENSE">progress/JSDO license</a>. | ||
Notwithstanding the above, we reserve the right to ask you to sign a <a href="https://www.progress.com/jsdo/cla ">Contributor License Agreement (CLA)</a> for larger changes. | ||
* Search <a href="https://github.com/progress/JSDO/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. | ||
* Clone the repository. | ||
|
||
- By submitting a pull request, you represent that you have the right to license your contribution to Progress and the community, and agree by submitting the patch that your contributions are licensed under the <a href="https://github.com/progress/JSDO/blob/master/LICENSE">progress/JSDO license</a>. | ||
Notwithstanding the above, we reserve the right to ask you to sign a <a href="https://www.progress.com/jsdo/cla ">Contributor License Agreement (CLA)</a> for larger changes. | ||
- Search <a href="https://github.com/progress/JSDO/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. | ||
- Clone the repository. | ||
|
||
```bash | ||
git clone [email protected]:progress/JSDO.git -b develop | ||
``` | ||
* Initialize the submodule. | ||
|
||
- Initialize the submodule. | ||
|
||
```bash | ||
git submodule init | ||
``` | ||
* Fetch data from the submodule. | ||
|
||
- Fetch data from the submodule. | ||
|
||
```bash | ||
git submodule update | ||
``` | ||
* Make your changes in a new `git` branch. We use the <a href="http://nvie.com/posts/a-successful-git-branching-model/">Gitflow branching model</a>. | ||
|
||
* Commit your changes and create a descriptive commit message (the commit message is used to generate release notes). | ||
- Make your changes in a new `git` branch. We use the <a href="http://nvie.com/posts/a-successful-git-branching-model/">Gitflow branching model</a>. | ||
|
||
- Commit your changes and create a descriptive commit message (the commit message is used to generate release notes). | ||
|
||
```bash | ||
git commit -a | ||
``` | ||
* Ensure your changes pass the Mocha tests for the JSDO. | ||
|
||
- Ensure your changes pass the Mocha tests for the JSDO. | ||
|
||
```bash | ||
npm install | ||
npm test | ||
``` | ||
* Push your branch to GitHub. | ||
|
||
- Push your branch to GitHub. | ||
|
||
```bash | ||
git push origin my-fix-branch | ||
``` | ||
* In GitHub, send a Pull Request to JSDO:develop. | ||
* If we suggest changes, you can modify your branch, rebase, and force a new push to your GitHub repository to update the Pull Request. | ||
|
||
- In GitHub, send a Pull Request to JSDO:develop. | ||
- If we suggest changes, you can modify your branch, rebase, and force a new push to your GitHub repository to update the Pull Request. | ||
|
||
```bash | ||
git rebase develop -i | ||
git push -f | ||
|
@@ -76,19 +89,26 @@ That's it! Thank you for your contribution! | |
|
||
When the patch is reviewed and merged, you can safely delete your branch and pull the changes from the main (upstream) repository. | ||
|
||
* Delete the remote branch on GitHub. | ||
- Delete the remote branch on GitHub. | ||
|
||
```bash | ||
git push origin --delete my-fix-branch | ||
``` | ||
* Check out the develop branch. | ||
|
||
- Check out the develop branch. | ||
|
||
```bash | ||
git checkout develop -f | ||
``` | ||
* Delete the local branch. | ||
|
||
- Delete the local branch. | ||
|
||
```bash | ||
git branch -D my-fix-branch | ||
``` | ||
* Update your develop branch with the latest upstream version. | ||
|
||
- Update your develop branch with the latest upstream version. | ||
|
||
``` | ||
git pull --ff upstream develop | ||
``` | ||
|
Oops, something went wrong.