Welcome to the project!
We encourage contribution in a manner consistent with the Code of Conduct. The following will guide you through the process.
There are a number of ways you can contribute:
If your contribution modifies the git repository, the following agreements must be established.
Note: License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository. In simple terms, license agreements are needed before pull requests can be accepted. A license agreement is not needed for submitting feature request, bug reporting, or other project management.
In order to contribute to this repository, an Individual Contributor License Agreement (ICLA) must be completed, submitted and accepted.
If the contribution to this repository is on behalf of a company, a Corporate Contributor License Agreement (CCLA) must also be completed, submitted and accepted.
The license agreement for this repository is stated in the LICENSE file.
Please do not use the GitHub issue tracker to submit questions.
TODO: Instead, use ???
- ??? Slack ???
- ??? stackoverflow.com ???
All feature requests are "GitHub issues". To request a feature, create a GitHub issue in this repository.
When creating an issue, there will be a choice to create a "Bug report" or a "Feature request". Choose "Feature request".
All bug reports are "GitHub issues". Before reporting on a bug, check to see if it has already been reported. To report a bug, create a GitHub issue in this repository.
When creating an issue, there will be a choice to create a "Bug report" or a "Feature request". Choose "Bug report".
To contribute code or documentation to the repository, you must have License Agreements in place. This needs to be complete before a Pull Request can be accepted.
These variables may be modified, but do not need to be modified. The variables are used throughout the installation procedure.
export GIT_ACCOUNT=senzing
export GIT_REPOSITORY=g2updateproject
Synthesize environment variables.
export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
export GIT_REPOSITORY_URL="[email protected]:${GIT_ACCOUNT}/${GIT_REPOSITORY}.git"
Get repository.
mkdir --parents ${GIT_ACCOUNT_DIR}
cd ${GIT_ACCOUNT_DIR}
git clone ${GIT_REPOSITORY_URL}
cd ${GIT_REPOSITORY_DIR}
TODO:
TODO:
Code in the main branch is modified via GitHub pull request. Follow GitHub's Creating a pull request from a branch or Creating a pull request from a fork instructions.
Accepting pull requests will be at the discretion of Senzing, Inc. and the repository owner(s).