Adding Content to Legal Forum
Our aim is to establish a strong community network, sharing legal findings and other suggestions with each other. We would like to encourage all of the current and future operators to do research about the situation in the jurisdiction they operate in, to share solutions to the challenges they encountered when running Exit Gateway, and create a pull request (PR).
First of all, please join our Node Operators Legal Forum (opens in a new tab) (Matrix chat) and post any information or questions there.
To add your information to this book, you can create a PR directly to our repository (opens in a new tab).
Our documentation often refer to syntax annotated in <>
brackets. We use this expression for variables that are unique to each user (like path, local moniker, versions etcetra).
Any syntax in <>
brackets needs to be substituted with your correct name or version, without the <>
brackets. If you are unsure, please check our table of essential parameters and variables (opens in a new tab).
Steps to make a pull request:
1. Write down your legal findings, suggestions, communication templates, FAQ in a text editor
2. Clone nymtech/nym
repository or pull in case you already have it and switch to develop
branch
- Clone the repository
git clone https://github.com/nymtech/nym.git
- Go to the directory nym
cd nym
- Switch to branch develop and update the branch
git checkout develop
git pull origin develop
3. Make your own branch based off develop
and switch to it
- Choose a descriptive and consise name without using
<>
brackets
git checkout -b operators/community-counsel/<NEW_BRANCH_NAME>
# example: git checkout -b operators/community-counsel/alice-vps-faq-template
- Verify that you are on the right branch
git branch
4. Save your legal findings as <JURISDICTION_NAME>.md
to /nym/documentation/docs/pages/operators/community-counsel/jurisdictions
or add info to an existing page
5. Add to git, commit and push your changes
cd documentation/docs/pages/operators/community-counsel/jurisdictions
git add <FILE_NAME>.md
git commit -am "<DESCRIBE YOUR CHANGES>"
git push origin operators/community-counsel/<NEW_BRANCH_NAME>
6. Create a pull request
- Open the git generated link in your browser, fill the description and click on
Create a Pull Request
button
# the url will look like this
https://github.com/nymtech/nym/pull/new/operators/community-counsel/<NEW_BRANCH_NAME>
7. Notify others in the Node Operators Legal Forum (opens in a new tab) (Matrix chat) about the PR.
- Someone from the team will reach out to you, stay in touch to finalise the PR