Merge pull request #177 from RobLBaker/main

add CONTRIBUTING.md file

Author: RobLBaker

CONTRIBUTING.md

@@ -0,0 +1,130 @@
+---
+title: "CONTRIBUTING"
+output: html_document
+---
+
+# Contributing to CONTRIBUTING.md
+
+First off, thanks for taking the time to contribute!
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 
+
+> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+> - Star the project
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
+> - Cite these packages in your published works
+
+## Table of Contents
+
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+- [Your First Code Contribution](#your-first-code-contribution)
+- [Improving The Documentation](#improving-the-documentation)
+- [Styleguides](#styleguides)
+- [Commit Messages](#commit-messages)
+- [Join The Project Team](#join-the-project-team)
+
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [Documentation](https://nationalparkservice.github.io/EMLeditor/).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/nationalparkservice/EMLeditor/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://github.com/nationalparkservice/EMLeditor/issues/new/choose).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions , depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+
+
+## I Want To Contribute
+
+> ### Legal Notice 
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://nationalparkservice.github.io/EMLeditor/). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/nationalparkservice/EMLeditor/issues/new/choose).
+- Also make sure to search the internet to see if users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+- Stack trace (Traceback)
+- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+- Possibly your input and the output
+- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to robert_baker@nps.gov.
+
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/nationalparkservice/EMLeditor/issues/new/choose). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. See [https://gist.github.com/hadley/270442](https://gist.github.com/hadley/270442) for a great run down on how to create reproducible examples.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags, and the issue will be left to be implemented by someone on the development team. You may also address the issue yourself and issue a pull request, which will be reviewed by the development team.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://nationalparkservice.github.io/EMLeditor/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/nationalparkservice/EMLeditor/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library or package.
+- Please consult with the developers if you would like to create an add-on package. Maybe we can help!
+
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/nationalparkservice/EMLeditor/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. 
+- **Explain why this enhancement would be useful** to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+### Your First Code Contribution
+If you would like to contribute code please make the adjustments and issue a pull request. The development team will review your code prior to merging and pull request. Before issuing a pull request make sure:
+1) You have added a description of any changes made to the changelog in NEWS.md
+2) If you have added a function, make sure you also include unit tests that cover the function. If you have changed a function, make sure the unit tests still pass.
+3) If you have added or changed a function, make sure that the package loads using `devtools::load_all()`.
+2) You have updated any necessary documentation using `devtools::document()` 
+3) You have updated the associated web pages using `pkgdown::build_site_github_pages()` 
+4) You have checked that there are no errors or warnings when the package is built using `devtools::check()`.
+
+## Styleguides
+We encourage the use of the [tidyverse style guide](https://style.tidyverse.org/).
+
+### Commit Messages
+Commit messages should be short and descriptive.
+
+
+## Attribution
+This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)!

NEWS.md

@@ -1,12 +1,17 @@
 # EMLeditor v1.0.1(under development)
+## 2025-02-22
+  * Add `CONTRIBUTING.md` file
+  
 ## 2025-02-06
   * Bug fix in `set_int_rights` that was affecting CC0 licenses.
 
 # EMLeditor v1.0.0
 ## 2025-01-16
   * Fix bug in `set_project` and update associated documentation.
+
 ## 2024-11-04
   * Fix documentation in EMLscript code chunk that can make it difficult/confusing to enter user input after running the `upload_data_package` function.
+
 ## 2024-10-23
   * updates and fixes to documentation including spelling, grammar, and clarity
   * remove non-exported functions from documentation
@@ -15,6 +20,7 @@
 # EMLeditor v0.1.6
 ## 2024-09-17
   * Update `set_content_units` to have correct east and west GPS coordinates for bounding boxes.
+
 ## 2024-08-29
   * Update readme: add R-CMD-CHECK badge; use pak to install instead of devtools
   * Update licenseName field on restricted references to read, "Unlicensed (not for public dissemination)"
@@ -23,23 +29,31 @@
   * update `set_project` so that it adds projects instead of replacing them.
   * update `set_project` to use cli errors/warnings
   * add minimal unit test for `set_project`
+
 ## 2024-08-21
   * add id tag to projects to help DataStore identify DataStore projects vs. other projects.
+
 ## 2024-08-20
   * add helper.R file with a test_path function to facilitate unit tests
   * update unit test code to run both interactively and during build checks
   * add yaml file to conduct github actions: build test
+
 ## 2024-07-10
   * add in the new function `set_project()` and attempt to update existing function, `set_protocol()`.
   * update license from MIT to CC0.
+
 ## 2024-07-02
   * updated all API requests to user v6 API instead of v7.
+
 ## 2024-07-01
   * Updated `.get_park_polygon()` to use the latest version of the API rather than a legacy version.
+
 ## 2024-06-26
   * Added new function, `set_new_creator()` which can add one or more creators to EML.
+
 ## 2024-05-01
   * Fix documentation: typo/formatting for the description of `set_int_rights()` in the EML Creation Script github.io page.
+
 ## 2024-04-29
   * Bug fix for `set_cui()` deprecation message: now points to the correct updated function (`set_cui_code()`).
 
@@ -94,16 +108,17 @@
 
 ## 06 October 2023
   * Updated `set_datastore_doi()` and `upload_data_package()` functions to allow them to work with IRMA dev for testing and training purposes.
-* Updated `upload_data_package()` to prevent file upload if the reference already has files associated with it.
+  * Updated `upload_data_package()` to prevent file upload if the reference already has files associated with it.
 
 # EMLeditor v0.1.1 "Big South Fork"
 
 ## 29 August 2023
-  Updated all rest API services from v4/v5 to v6. Units services remain at v2.
+  * Updated all rest API services from v4/v5 to v6. Units services remain at v2.
 
 ## 15 August 2023
   * Fix bugs in `get_authors()`
   * Fix bugs in `get_abstract()`
+
 ## 19 July 2023
   * Fix examples in `set_creator_orgs()`
   * Add function `set_methods()` allows user to add or replace existing methods sections.
@@ -114,8 +129,10 @@
 ## 12 July 2023
   * Add global variable bindings
   * Fix how set_creator_orcids handles orcids; now takes a 19-char string as input and saves orcid as a 37-char string with "https://orcid.org/" prefix.
+
 ## 10 July 2023
   * Fixed minor typos in EML creation script.
+
 ## 30 June 2023
   * Added a "park_units" parameter to `set_creator_orgs()`. This takes a park unit (or list of park units) and uses the IRMA units service to populate the organizationName with the FullName of the park_unit specified. If you specify park_units, you cannot also specify "creator_orgs" - non-park unit organizations must be added as creators using a separate call to `set_creator_orgs()` (and the creators can subsequently be reorganized using `set_creator_order()`).