chore: contributing-information #543
Conversation
|
|
View your CI Pipeline Execution ↗ for commit fa4fe24.
☁️ Nx Cloud last updated this comment at |
| `pnpm nx e2e autoscript-suites` | ||
| `pnpm nx serve autoscript-apps` | ||
| ``` | ||
|
|
||
| ### Git Flow | ||
|
|
||
| Fork the repo to your own github account. From there, you can add the ForgeRock repository as an upstream. |
There was a problem hiding this comment.
I think we can move this content to the section Fork and Clone the Repository above
There was a problem hiding this comment.
I think we still need to address it
ryanbas21
force-pushed
the
contributing-information
branch
from
0339720 to
d8259f9
Compare
ryanbas21
force-pushed
the
contributing-information
branch
from
d8259f9 to
fa4fe24
Compare
|
|
||
| ## Standards of Practice | ||
|
|
||
| We ask that all contributors to this project adhere to our engineering Standard for team culture, practices and code of conduct. We expect everyone to be respectful, inclusive, and collaborative. Any violations will be handled according to the project's guidelines. |
There was a problem hiding this comment.
Should we provide a link to these standards/guidelines?
|
|
||
| We ask that all contributors to this project adhere to our engineering Standard for team culture, practices and code of conduct. We expect everyone to be respectful, inclusive, and collaborative. Any violations will be handled according to the project's guidelines. | ||
|
|
||
| For more details on our Standards of Practice, please refer to the SDK Standards of Practice documentation. |
There was a problem hiding this comment.
| For more details on our Standards of Practice, please refer to the SDK Standards of Practice documentation. | |
| For more details on our Standards of Practice, please refer to the [SDK Standards of Practice](https://github.com/ForgeRock/sdk-standards-of-practice) documentation. |
|
|
||
| For more details on our Standards of Practice, please refer to the SDK Standards of Practice documentation. | ||
|
|
||
| ### Here is a checklist of items to ensure your Pull Request is reviewed and ready to be merged: |
There was a problem hiding this comment.
| ### Here is a checklist of items to ensure your Pull Request is reviewed and ready to be merged: | |
| ## Creating a Pull Request (PR) | |
| This section covers how to create your changes, and submit them for review by Ping Identity engineers | |
| by using a Pull Request. A PR is a formal request to merge your changes from your forked repository into | |
| the main project. The following steps will guide you on creating a well-structured PR that | |
| facilitates efficient review and integration of your contributions. | |
| ### Create a New Branch | |
| Always create a new branch to work on your changes. Avoid making changes directly on the `develop` or `master` branch. | |
| ```bash | |
| git checkout -b feature/my-new-feature |
Make Your Changes
Implement the required changes or new features. Make sure to write clean, well-commented, and readable code. If applicable, include tests and documentation for the new functionality.
Commit Your Changes
Once you’ve made your changes, commit them with a clear and descriptive message. Note that our
repository requires all commits to be signed. For more information on signing commits, please refer to
the GitHub Docs
The commit message should follow this structure:
[TYPE] Short description of the changes
Types:
feat: A new featurefix: A bug fixdocs: Documentation changesrefactor: Code refactoring (no feature change)test: Adding or modifying tests
Example:
git commit -S -m "feat: add login functionality"Push Your Changes
After committing your changes, push them to your fork:
git push origin feature/my-new-featureCreate a Pull Request
-
Go to your fork on GitHub.
-
Click on the "New Pull Request" button.
-
Select the base repository and base branch (usually
develop), then select the branch you just pushed. -
Fill out the PR Template
Make sure to fill out the PR template provided. The template helps us better understand your change. Typically, a PR will require the following information:
- Add a title and description for the PR. The description should include:
- What was changed and why.
- Any related issues.
- Any additional context if necessary, for example relevant screenshots or breaking changes.
Once everything looks good, submit the PR for review.
- Add a title and description for the PR. The description should include:
PR Review and Feedback
Once the PR is submitted, the team will review it. Be prepared to:
- Address any feedback or requested changes.
- Keep your branch up to date with the base branch by rebasing or merging.
Here is a checklist of items to ensure your Pull Request is reviewed and ready to be merged:
|
|
||
| :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: | ||
| Welcome! We are excited that you are interested in contributing to the Ping SDK for JavaScript. This document will guide you through the steps required to contribute to the project. | ||
|
|
||
| The following is a set of guidelines for contributing to the Forgerock SDK and its packages, which are hosted in the [ForgeRock organization](https://github.com/forgerock) on GitHub. |
There was a problem hiding this comment.
| The following is a set of guidelines for contributing to the Forgerock SDK and its packages, which are hosted in the [ForgeRock organization](https://github.com/forgerock) on GitHub. | |
| The following is a set of guidelines for contributing to the Ping SDK and its packages, which are hosted in the [ForgeRock organization](https://github.com/forgerock) on GitHub. |
JIRA Ticket
https://pingidentity.atlassian.net/browse/SDKS-3970
Description
Add and align the contributing documentation with other platforms