CONTRIBUTING.md
In bmewing/mgsub: Safe, Multiple, Simultaneous String Substitution
Contributing to mgsub
So, you want to contribute to this project! That's awesome. However, before
doing so, please read the following simple steps how to contribute. This will
make the life easier and will avoid wasting time on things which are not
requested.
Discuss the changes before doing them
-
First of all, open an issue in the repository, using the bug tracker,
describing the contribution you would like to make, the bug you found or any
other ideas you have. This will help us to get you started on the right
foot.
-
If it makes sense, add the platform and software information (e.g. operating
system, R version etc.), screenshots (so we can see what you are
seeing).
-
It is recommended to wait for feedback before continuing to next steps.
However, if the issue is clear (e.g. a typo) and the fix is simple, you can
continue and fix it.
Fixing issues
-
Fork the project in your account and create a branch with your fix:
some-great-feature or some-issue-fix.
-
Commit your changes in that branch. Additionally, write tests that cover the bug discovered and maintain at least our current level of code coverage.
-
Feel free to add yourself tn the Authors@R vector in DESCRIPTION:
yaml
Authors@R: c(
person("Mark", "Ewing", email="b.mark@ewingsonline.com", role=c("aut","cre")),
person("Your", "Name", role=c("aut"))
)
Creating a pull request
-
Open a pull request, and reference the initial issue in the pull request
message (e.g. fixes #). Write a good description and
title, so everybody will know what is fixed/improved.
-
If it makes sense, add screenshots, gifs etc., so it is easier to see what
is going on.
Wait for feedback
Before accepting your contributions, we will review them. You may get feedback
about what should be fixed in your modified code. If so, just keep committing
in your branch and the pull request will be updated automatically.
Final Merging!
Finally, your contributions will be merged. Contributions are more than welcome!
bmewing/mgsub documentation built on Nov. 4, 2022, 1:57 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Contributing to mgsub
So, you want to contribute to this project! That's awesome. However, before doing so, please read the following simple steps how to contribute. This will make the life easier and will avoid wasting time on things which are not requested.
Discuss the changes before doing them
-
First of all, open an issue in the repository, using the bug tracker, describing the contribution you would like to make, the bug you found or any other ideas you have. This will help us to get you started on the right foot.
-
If it makes sense, add the platform and software information (e.g. operating system, R version etc.), screenshots (so we can see what you are seeing).
-
It is recommended to wait for feedback before continuing to next steps. However, if the issue is clear (e.g. a typo) and the fix is simple, you can continue and fix it.
Fixing issues
-
Fork the project in your account and create a branch with your fix:
some-great-featureorsome-issue-fix. -
Commit your changes in that branch. Additionally, write tests that cover the bug discovered and maintain at least our current level of code coverage.
-
Feel free to add yourself tn the
Authors@Rvector inDESCRIPTION:
yaml
Authors@R: c(
person("Mark", "Ewing", email="b.mark@ewingsonline.com", role=c("aut","cre")),
person("Your", "Name", role=c("aut"))
)
Creating a pull request
-
Open a pull request, and reference the initial issue in the pull request message (e.g. fixes #). Write a good description and title, so everybody will know what is fixed/improved.
-
If it makes sense, add screenshots, gifs etc., so it is easier to see what is going on.
Wait for feedback
Before accepting your contributions, we will review them. You may get feedback about what should be fixed in your modified code. If so, just keep committing in your branch and the pull request will be updated automatically.
Final Merging!
Finally, your contributions will be merged. Contributions are more than welcome!
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.