SRCH-2593 updating translation guidance (#52)

Author: Amani Farooque

.github/pull_request_template.md

@@ -0,0 +1,30 @@
+## Summary
+- Brief summary of the changes included in this PR
+- Any additional information or context which may help the reviewer
+ 
+### Checklist
+Please ensure you have addressed all concerns below before marking a PR "ready for review" or before requesting a re-review:
+ 
+#### Functionality Checks
+ 
+- [ ] Code is functional, as tested locally.
+
+- [ ] Tests have been added or updated to cover the proposed changes. If not, please explain why tests aren't needed:
+
+- [ ] Automated checks pass, if applicable. If CodeClimate checks do not pass, explain reason for failures:
+ 
+- [ ] If your changes will be tested manually, you have run `bundle update` and committed your changes to Gemfile.lock.
+ 
+- [ ] You have merged the latest changes from the target branch (usually `master` or `main`) into your branch.
+ 
+- [ ] Your target branch is `master`, `main`, or `production`, or you have specified the reason for an alternate branch here:
+ 
+- [ ] PR title is either of the format **SRCH-#### \<description\>** matching the associated Jira ticket (i.e. "SRCH-123 implement feature X"), or **Release - SRCH-####, SRCH-####, SRCH-####** matching the Jira ticket numbers in the release.
+ 
+- [ ] You have squashed your commits into a single commit (exceptions: your PR includes commits with formatting-only changes, such as required by Rubocop or Cookstyle, or if this is a feature branch that includes multiple commits)
+ 
+- [ ] Your primary commit message is of the format **SRCH-#### \<description\>** matching the associated Jira ticket
+ 
+#### Process Checks
+ 
+- [ ] You have specified an "Assignee", and if necessary, additional reviewers

CONTRIBUTING.md

@@ -1,31 +1,15 @@
 Contributing to Punchcard
 =========================
 
-Punchard is work of [multiple contributors](https://github.com/GSA/punchcard/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/GSA/punchcard/pulls), [propose features and discuss issues](https://github.com/GSA/punchcard/issues).
+Punchcard is the work of [multiple contributors](https://github.com/GSA/punchcard/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/GSA/punchcard/pulls), [propose features and discuss issues](https://github.com/GSA/punchcard/issues).
 
-
-#### Contributing to localization files
-
-These files are in the YAML format.
-
-You can edit existing files or create new files directly via the [Github web interface](https://github.com/GSA/punchcard/tree/master/localizations). Or, you can use Git from the command line (see below). Either way, follow these steps to create a new localization file:
-
-1. Start with `non_es_en_template.yml` and copy it into your new locale file. The reason you are using `non_es_en_template.yml` and not `en.yml` or `es.yml` is because the English and Spanish locale files contain many translations that are not used in other locales.
-1. Change the two letter locale in line 1 of your new file from `non_es_en_template` to match the locale of the filename.
-1. Be sure to follow the instructions for date-related fields like `cdr_format`, `date_format`, and `slashes`. Case is important!
-1. Be careful with preserving any opening/closing quotes around strings.
-1. Once you have the file ready, copy/paste it into a [YAML validator](http://www.yamllint.com) to ensure what you have is valid YAML.
-1. Commit the change in Github
+Note: As of November 2021, management of multilingual support has moved from the [GSA/Punchcard](https://github.com/GSA/punchcard/) repository to the [GSA/search-gov](https://github.com/GSA/search-gov) repository. Learn how to contribute to multilingual search support on Search.gov [here](https://github.com/GSA/search-gov/blob/master/CONTRIBUTING.md).
 
 #### Fork the Project
 
-If you don't want to use the [Github web interface](https://github.com/GSA/punchcard/tree/master/localizations), you can use the command line tools to fork the [project on Github](https://github.com/GSA/punchcard) and check out your copy.
+If you don't want to use the [Github web interface](https://github.com/GSA/punchcard/tree/master/), you can use the command line tools to fork the [project on Github](https://github.com/GSA/punchcard) and check out your copy.
 
-```
-git clone https://github.com/contributor/punchcard.git
-cd punchcard
-git remote add upstream https://github.com/GSA/punchcard.git
-```
+Instructions on how to fork a project can be found [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
 
 #### Create a Topic Branch
 
@@ -43,7 +27,7 @@ Make sure git knows your name and email address:
 
 ```
 git config --global user.name "Your Name"
-git config --global user.email "contributor@example.com"
+git config --global user.email "youremail@example.com"
 ```
 
 Writing good commit logs is important. A commit log should describe what changed and why.
@@ -61,11 +45,13 @@ git push origin my-feature-branch
 
 #### Make a Pull Request
 
-Go to https://github.com/contributor/punchcard and select your feature branch. Click the 'Pull Request' button and fill out the form. A series of automated tests will run on [CirclCI](https://circleci.com/gh/GSA/punchcard). If tests pass, your pull request will usually get reviewed and accepted within a few days.
-
-#### Be Patient
+[Create a PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) to propose your changes. A series of automated tests will run on [CircleCI](https://circleci.com/gh/GSA/punchcard), and a checklist will be automatically inserted into the body of the PR. You may ignore the following items:
+* If your changes will be tested manually, you have run bundle update and committed your changes to Gemfile.lock
+* PR title is either of the format SRCH-#### <description> matching the associated Jira ticket (i.e. "SRCH-123 implement feature X"), or Release #.#.# matching the release number
+* Your primary commit message is of the format SRCH-#### <description> matching the associated Jira ticket
+* You have specified an "Assignee", and if necessary, additional reviewers
 
-It's likely that your change will not be merged and that the nitpicky maintainers (or CircleCI) will ask you to do more, or fix seemingly benign problems. Hang on there!
+If tests pass and the other checklist items are complete, your pull request will usually get reviewed and accepted within a few days.
 
 #### Thank You
 

README.md

@@ -304,11 +304,10 @@ The Elasticsearch index mapping used to transform entries into analyzed fields i
 
 # Localizations (l10n)
 
-The Search.gov application uses these YAML files to provide localized translations of text strings 
-based on the locale set for the user.
+As of November 2021, translations management has moved to the [GSA/search-gov](https://github.com/GSA/search-gov) repository. Learn how to contribute to Search.gov translations [here](https://github.com/GSA/search-gov/blob/master/CONTRIBUTING.md).
 
-## Contributing
+# Contributing
 
 You're encouraged to submit changes via pull requests, propose features and discuss issues.
 
-See [CONTRIBUTING](CONTRIBUTING.md).
+See [CONTRIBUTING](CONTRIBUTING.md).