Skip to content

Commit

Permalink
Add CONTRIBUTING.md, rename LICENSE to LICENSE.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-s committed Jul 30, 2024
1 parent dbc2cb2 commit 0f8bda2
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 4 deletions.
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing to this repository

We welcome your contributions! There are multiple ways to contribute.

## Opening issues

For bugs or enhancement requests, please file a GitHub issue unless it's
security related. When filing a bug remember that the better written the bug is,
the more likely it is to be fixed. If you think you've found a security
vulnerability, do not raise a GitHub issue and follow the instructions in our
[security policy](./SECURITY.md).

## Contributing code

We welcome your code contributions. Before submitting code via a pull request,
you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and
your commits need to include the following line using the name and e-mail
address you used to sign the OCA:

```text
Signed-off-by: Your Name <[email protected]>
```

This can be automatically added to pull requests by committing with `--sign-off`
or `-s`, e.g.

```text
git commit --signoff
```

Only pull requests from committers that can be verified as having signed the OCA
can be accepted.

## Pull request process

1. Ensure there is an issue created to track and discuss the fix or enhancement
you intend to submit.
1. Fork this repository.
1. Create a branch in your fork to implement the changes. We recommend using
the issue number as part of your branch name, e.g. `1234-fixes`.
1. Ensure that any documentation is updated with the changes that are required
by your change.
1. Ensure that any samples are updated if the base image has been changed.
1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
what your changes are meant to do and provide simple steps on how to validate.
your changes. Ensure that you reference the issue you created as well.
1. We will assign the pull request to 2-3 people for review before it is merged.

## Code of conduct

Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].

[OCA]: https://oca.opensource.oracle.com
[COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/
File renamed without changes.
8 changes: 4 additions & 4 deletions mx.fastr/mx_fastr_dists.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def getResults(self):
results = []
for rdir in ['bin', 'include', 'lib', 'library', 'etc', 'share', 'doc']:
self._get_files(rdir, results)
results.append(join(self.dir, 'LICENSE'))
results.append(join(self.dir, 'LICENSE.txt'))
results.append(join(self.dir, 'COPYRIGHT'))
results.append(join(self.dir, 'README.md'))
return results
Expand Down Expand Up @@ -109,7 +109,7 @@ def build(self):
data = infile.read()
outfile.write(data)
# license/README
shutil.copy(join(fastr_dir, 'LICENSE'), output_dir)
shutil.copy(join(fastr_dir, 'LICENSE.txt'), output_dir)
shutil.copy(join(fastr_dir, 'README.md'), output_dir)

# jar files for the launchers
Expand Down Expand Up @@ -171,15 +171,15 @@ def mx_register_dynamic_suite_constituents(register_project, register_distributi
"path": "*",
"exclude": [
"COPYRIGHT",
"LICENSE",
"LICENSE.txt",
"README.md",
"bin/Rscript",
"bin/fastr_jars",
"bin/exec/R",
],
},
],
"LICENSE_FASTR" : "file:LICENSE",
"LICENSE_FASTR" : "file:LICENSE.txt",
"3rd_party_licenses_fastr.txt" : "file:3rd_party_licenses.txt",
"README_FASTR": "extracted-dependency:fastr:FASTR_GRAALVM_RELEASE/README.md",
"bin/Rscript": "file:com.oracle.truffle.r.release/src/Rscript_launcher",
Expand Down

0 comments on commit 0f8bda2

Please sign in to comment.