-
Couldn't load subscription status.
- Fork 28
draft: deduplicate C-of-C; extend CONTRIBUTING #248
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
russHyde
wants to merge
6
commits into
r-devel:main
Choose a base branch
from
russHyde:update-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7c8a87e
remove duplicated code of conduct; CONDUCT.md was based on a conduct …
russHyde 45f0b62
fix hyperlink to issues/new in CONTRIBUTING
russHyde 2a8512b
fix hyperlink to issues/new in README
russHyde 01c5b53
extend contributing guide to include content from template
russHyde 650f45d
replace placeholder with project name in CONTRIBUTING
russHyde e4f2a45
remove outdated maintainer email
russHyde File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,206 @@ | ||
| # Contributing | ||
|
|
||
| ## Without write access | ||
| <!-- omit in toc --> | ||
| # Contributing to the CURRENT_PROJECT | ||
|
|
||
| Corrections, suggestions and general improvements are welcome as [issue submissions](issues/new). | ||
| <!-- | ||
| For a new project, search-and-replace | ||
| - CURRENT_PROJECT | ||
| --> | ||
|
|
||
| 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 | ||
| > - Tweet about it | ||
| > - Refer this project in your project's readme | ||
| > - Mention the project at local meetups and tell your friends/colleagues | ||
| <!-- omit in toc --> | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| <!-- markdownlint-disable link-fragments --> | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [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) | ||
| <!-- markdownlint-enable link-fragments --> | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project and everyone participating in it is governed by the | ||
| [CURRENT_PROJECT Code of Conduct](CODE_OF_CONDUCT.md). | ||
| By participating, you are expected to uphold this code. Please report | ||
| unacceptable behavior to <MAINTAINER>. | ||
|
|
||
| ## I Have a Question | ||
|
|
||
| > If you want to ask a question, we assume that you have read the available | ||
| > documentation. | ||
| Before you ask a question, it is best to search for existing | ||
| [Issues](/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](/issues/new). | ||
| - Provide as much context as you can about what you're running into. | ||
| - Provide project and platform versions (nodejs, npm, etc), depending on what | ||
| seems relevant. | ||
|
|
||
| We will then take care of the issue as soon as possible. | ||
|
|
||
| <!-- You might want to create a separate issue tag for questions and include it | ||
| in this description. People should then tag their issues accordingly. | ||
| Depending on how large the project is, you may want to outsource the | ||
| questioning, e.g. to Stack Overflow or Gitter. You may add additional contact | ||
| and information possibilities: | ||
| - IRC | ||
| - Slack | ||
| - Gitter | ||
| - Stack Overflow tag | ||
| - Blog | ||
| - FAQ | ||
| - Roadmap | ||
| - E-Mail List | ||
| - Forum --> | ||
|
|
||
| ## I Want To Contribute | ||
|
|
||
| > ### Legal Notice <!-- omit in toc --> | ||
| > | ||
| > 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. | ||
| ### Without write access | ||
|
|
||
| Corrections, suggestions and general improvements are welcome as [issue submissions](/issues/new). | ||
|
|
||
| You can also suggest changes by editing the .Rmd files that are at the root of this repository and submitting a pull request. Please target your pull requests to the `main` branch. | ||
|
|
||
| ## With write access | ||
| ### With write access | ||
|
|
||
| You can push directly to `main` for small fixes. Please use PRs to `main` for discussing larger updates - try to limit to one section or at least one chapter in each PR, so that changes are easier to review. | ||
|
|
||
| ### Reporting Bugs | ||
|
|
||
| <!-- omit in toc --> | ||
| #### 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.) | ||
| - 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](/issues?q=label%3Abug). | ||
|
|
||
| <!-- omit in toc --> | ||
| #### 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 | ||
| <[email protected]>. <!-- You may add a PGP key to allow the messages to | ||
| be sent encrypted as well. --> | ||
|
|
||
| We use GitHub issues to track bugs and errors. If you run into an issue with the | ||
| project: | ||
|
|
||
| - Open an [Issue](/issues/new). (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. | ||
| - Provide the information you collected in the previous section. | ||
|
|
||
| <!-- You might want to create an issue template for bugs and errors that can be | ||
| used as a guide and that defines the structure of the information to be | ||
| included. If you do so, reference it here in the description. --> | ||
|
|
||
| ### Suggesting Enhancements | ||
|
|
||
| This section guides you through submitting an enhancement suggestion for the | ||
| CURRENT_PROJECT, **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. | ||
|
|
||
| <!-- omit in toc --> | ||
| #### Before Submitting an Enhancement | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - Read the documentation carefully and find out if the functionality is already | ||
| covered, maybe by an individual configuration. | ||
| - Perform a [search](/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. | ||
|
|
||
| <!-- omit in toc --> | ||
| #### How Do I Submit a Good Enhancement Suggestion? | ||
|
|
||
| Enhancement suggestions are tracked as | ||
| [GitHub issues](/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. <!-- this should | ||
| only be included if the project has a GUI --> | ||
| - **Explain why this enhancement would be useful** to most CURRENT_PROJECT | ||
| users. You may also want to point out the other projects that solved it better | ||
| and which could serve as inspiration. | ||
|
|
||
| <!-- You might want to create an issue template for enhancement suggestions that | ||
| can be used as a guide and that defines the structure of the information to be | ||
| included. If you do so, reference it here in the description. --> | ||
|
|
||
| <!-- omit in toc --> | ||
| ## Attribution | ||
|
|
||
| This guide is based on the **contributing-gen**. | ||
| [Make your own](https://github.com/bttger/contributing-gen)! | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: replace CURRENT_PROJECT with project name