Skip to content

Commit

Permalink
link to contributing.md from readme.
Browse files Browse the repository at this point in the history
update to contribution guidelines.
  • Loading branch information
PawelPawelec-RDX committed Feb 2, 2024
1 parent 63c9476 commit 8d4a260
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 13 deletions.
95 changes: 84 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,29 +42,26 @@ If you encounter a bug or have a problem with the project, please open an issue

# Contributing Code

Submitting a Pull Request does not guarantee the acceptance of your proposed changes. We strongly advise initiating a discussion with the team via Discord, Telegram, or Github Issues (for bugs) prior to commencing work on a PR.
Prior to commencing any work on a PR, we strongly advise initiating a discussion with the team via Discord, Telegram, or Github Issues (for bugs).

## Setting Up Your Development Environment
Submitting a Pull Request does not guarantee the acceptance of your proposed changes.

Note: adapt this as required for your repository
## Setting Up Your Development Environment

1. Fork the repository to your GitHub account.
2. Clone your forked repository to your local machine.
3. Create a new branch for your changes.
Please check [documentation](https://github.com/radixdlt/babylon-gateway/blob/main/docs/development.md) on how to setup local environment.

## Making Changes

1. Write clear, concise, and well-documented code.
2. Commit your changes with a descriptive commit message. Please follow the PROJECT’s commit message format.

## Testing
Note: adapt this as required for your repository

1. Ensure that your changes do not break existing tests.
1. Ensure that your changes do not break existing tests (`/tests` directory)
2. Write new tests for your code if applicable.
3. Run the test suite to make sure everything is passing.
3. Run the test suite to make sure everything is passing (you can do that by using `dotnet test` command or any IDE of your choice)

## Submitting a Pull Request
Note: adapt this as required for your repository (the target branch for the PR may change)

1. Push your changes to your forked repository:
2. Open a pull request against the `develop` branch of the original repository.
Expand All @@ -78,4 +75,80 @@ Pull requests will be reviewed by project maintainers. Reviewers may provide fee
# License
By contributing to Babylon Network Gateway, you agree that your contributions will be licensed under the Babylon Network Gateway license.

Insert license as in the README
The executable components of the Babylon Gateway Code are licensed under the [Radix Software EULA](http://www.radixdlt.com/terms/genericEULA).

The Babylon Gateway Code is released under the [Radix License 1.0 (modified Apache 2.0)](LICENSE):

```
Copyright 2023 Radix Publishing Ltd incorporated in Jersey, Channel Islands.
Licensed under the Radix License, Version 1.0 (the "License"); you may not use
this file except in compliance with the License.
You may obtain a copy of the License at:
https://www.radixfoundation.org/licenses/license-v1
The Licensor hereby grants permission for the Canonical version of the Work to
be published, distributed and used under or by reference to the Licensor’s
trademark Radix® and use of any unregistered trade names, logos or get-up.
The Licensor provides the Work (and each Contributor provides its Contributions)
on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
PURPOSE.
Whilst the Work is capable of being deployed, used and adopted (instantiated) to
create a distributed ledger it is your responsibility to test and validate the
code, together with all logic and performance of that code under all foreseeable
scenarios.
The Licensor does not make or purport to make and hereby excludes liability for
all and any representation, warranty or undertaking in any form whatsoever,
whether express or implied, to any entity or person, including any
representation, warranty or undertaking, as to the functionality security use,
value or other characteristics of any distributed ledger nor in respect the
functioning or value of any tokens which may be created stored or transferred
using the Work.
The Licensor does not warrant that the Work or any use of the Work complies with
any law or regulation in any territory where it may be implemented or used or
that it will be appropriate for any specific purpose.
Neither the licensor nor any current or former employees, officers, directors,
partners, trustees, representatives, agents, advisors, contractors, or
volunteers of the Licensor shall be liable for any direct or indirect, special,
incidental, consequential or other losses of any kind, in tort, contract or
otherwise (including but not limited to loss of revenue, income or profits, or
loss of use or data, or loss of reputation, or loss of any economic or other
opportunity of whatsoever nature or howsoever arising), arising out of or in
connection with (without limitation of any use, misuse, of any ledger system or
use made or its functionality or any performance or operation of any code or
protocol caused by bugs or programming or logic errors or otherwise);
A. any offer, purchase, holding, use, sale, exchange or transmission of any
cryptographic keys, tokens or assets created, exchanged, stored or arising from
any interaction with the Work;
B. any failure in a transmission or loss of any token or assets keys or other
digital artifacts due to errors in transmission;
C. bugs, hacks, logic errors or faults in the Work or any communication;
D. system software or apparatus including but not limited to losses caused by
errors in holding or transmitting tokens by any third-party;
E. breaches or failure of security including hacker attacks, loss or disclosure
of password, loss of private key, unauthorised use or misuse of such passwords
or keys;
F. any losses including loss of anticipated savings or other benefits resulting
from use of the Work or any changes to the Work (however implemented).
You are solely responsible for; testing, validating and evaluation of all
operation logic, functionality, security and appropriateness of using the Work
for any commercial or non-commercial purpose and for any reproduction or
redistribution by You of the Work. You assume all risks associated with Your use
of the Work and the exercise of permissions under this Licence.
```

3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ This system is designed to be the Radix-run publicly exposed gateway into the Ba
For documentation on the Gateway API, see the [Gateway API docs](https://docs-babylon.radixdlt.com/main/apis/api-specification.html).

## Community Involvement

If you have questions, suggestions or bug reports, please come to the [Network Gateway channel](https://discord.com/channels/417762285172555786/1149370695206318151) on the [Radix DLT Discord server](http://discord.gg/radixdlt).
Please see [CONTRIBUTING.md](./CONTRIBUTING.md)

## Structure

Expand Down
2 changes: 2 additions & 0 deletions babylon-gateway.sln
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".solution", ".solution", "{
.editorconfig = .editorconfig
.gitignore = .gitignore
CHANGELOG.md = CHANGELOG.md
CONTRIBUTING.md = CONTRIBUTING.md
CODE_OF_CONDUCT.md = CODE_OF_CONDUCT.md
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "RadixDlt.NetworkGateway.DataAggregator", "src\RadixDlt.NetworkGateway.DataAggregator\RadixDlt.NetworkGateway.DataAggregator.csproj", "{6C516526-0AB0-41ED-8DA0-8CBC7751CBF7}"
Expand Down

0 comments on commit 8d4a260

Please sign in to comment.