diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_element_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_element_template.md deleted file mode 100644 index e85d857..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_element_template.md +++ /dev/null @@ -1,35 +0,0 @@ -Please remove any sensitive information (e.g., passwords, API keys) from your submission. -Please fill in the details for all of the relevant items below. -Thank you for taking the time to complete this PR. It will be reviewed as soon as possible. - -## Element name -Provide a proposed name for the lattice element. This can be an abbreviation, and should be at most 1-2 words (e.g., Quadrupole). - -## Element description -Provide a brief description of the lattice element. Please include: -- A clear and concise description of the element (1-2 sentences) -- How the element is typically used (e.g., class of accelerator, beam dynamics purpose) - -## List of element parameters -Provide a bulleted list of the element parameters. For each parameter, include: -- a short symbol to denote the parameter -- type of the parameter (integer, float, array of float, etc.) -- physical units of the parameter -- a brief phrase describing the parameter - -## Physical model -Provide a well-defined mathematical description of the element and its parameters. This may include equations, figures, etc. -This description should completely specify the element in an unambiguous form, and may include one of the following: -- equations describing the physical geometry -- equations describing the electromagnetic fields -- equations describing the dynamical transfer map - -## Alternative descriptions -If applicable, provide a description of similar widely-used elements or alternative parameter sets. -The purpose is to provide disambiguation and to provide criteria that may be used to aid in classification and grouping. - -## Additional information -If applicable, please provide any additional information that may be relevant, such as: -- Links to existing codes or implementations -- Any relevant technical requirements or specifications -- References to relevant publications or research diff --git a/front_matter/pull_request_template.md b/.github/pull_request_template.md similarity index 100% rename from front_matter/pull_request_template.md rename to .github/pull_request_template.md diff --git a/front_matter/contributing.md b/front_matter/contributing.md index bbbf0f6..7e40e2e 100644 --- a/front_matter/contributing.md +++ b/front_matter/contributing.md @@ -3,14 +3,26 @@ Follow these steps **only once**: 1. Go to https://github.com/campa-consortium/lattice-standard. -2. Click the pulldown arrow next to `Fork`, click `Create a new fork`, and specify your GitHub username in the `Owner` field (e.g., "cemitch99"). +2. Click the pulldown arrow next to `Fork`, click `Create a new fork`, and specify your GitHub username in the `Owner` field (e.g., "username"). -3. Click `Code` to view and copy the URL of your fork -(e.g., https://github.com/cemitch99/lattice-standard.git) +3. Go back to https://github.com/campa-consortium/lattice-standard, click `Code` > `SSH`, and copy the url of the repo: +(e.g., git@github.com:campa-consortium/lattice-standard.git) -4. On your local machine, from the terminal, clone your fork: +The simpler option `Code` > `HTTPS` can be used if the user just want to look at the repo. (This does not require a password setup.) + +5. On your local machine, from the terminal, clone the main repository: +``` +git clone git@github.com:campa-consortium/lattice-standard.git +``` + +5. Rename what we just cloned: call it "mainline": +``` +git remote rename origin mainline ``` -git clone https://github.com/cemitch99/lattice-standard.git + +6. Add your remote repository in order to track it locally: +``` +git remote add username git@github.com:campa-consortium/lattice-standard.git ``` Follow these steps **each time you submit a pull request**: @@ -19,6 +31,12 @@ Follow these steps **each time you submit a pull request**: cd lattice-standard ``` +2. Make sure your local repository is up-to-date: +``` +git checkout main +git pull +``` + 2. Create a new branch with a descriptive name for the desired changes (e.g., "add_template"): ``` git checkout -b add_template @@ -39,9 +57,9 @@ git add pull_request_element_template.md git commit -m "Add element template." ``` -7. Push your changes to the remote repository: +7. Push the changes to your fork: ``` -git push origin add_template +git push -u username add_template ``` 8. Follow the link that is generated to open a new pull request on GitHub that includes these changes, e.g., go to https://github.com/cemitch99/lattice-standard/pull/new/add_template.