diff --git a/CONDUCT.md b/CONDUCT.md deleted file mode 100644 index e0771c9..0000000 --- a/CONDUCT.md +++ /dev/null @@ -1,24 +0,0 @@ -# Contributor Code of Conduct - -As contributors and maintainers of this project, we pledge to respect all people who -contribute through reporting issues, posting feature requests, updating documentation, -submitting pull requests or patches, and other activities. - -We are committed to making participation in this project a harassment-free experience for -everyone, regardless of level of experience, gender, gender identity and expression, -sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. - -Examples of unacceptable behavior by participants include the use of sexual language or -imagery, derogatory comments or personal attacks, trolling, public or private harassment, -insults, or other unprofessional conduct. - -Project maintainers have the right and responsibility to remove, edit, or reject comments, -commits, code, wiki edits, issues, and other contributions that are not aligned to this -Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed -from the project team. - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by -opening an issue or contacting one or more of the project maintainers. - -This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version 1.0.0, available at -https://contributor-covenant.org/version/1/0/0/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cccefaf..bf1b8cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,201 @@ # Contributing -## Without write access + +# Contributing to the R Development Guide -Corrections, suggestions and general improvements are welcome as [issue submissions](issues/new). +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 + + + +## Table of Contents + + +- [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) + + +## Code of Conduct + +This project and everyone participating in it is governed by the +[R Development Guide Code of Conduct](CODE_OF_CONDUCT.md). +By participating, you are expected to uphold this code. Please report +unacceptable behavior to . + +## 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. + + + +## 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. + +### 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 + + +#### 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). + + +#### 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 the +[maintenance team](https://github.com/r-devel/rdevguide?tab=readme-ov-file#contributors-). + +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. + + + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for the +R Development Guide, **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 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. + + +#### 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. +- **Explain why this enhancement would be useful** to most R Development Guide + users. You may also want to point out the other projects that solved it better + and which could serve as inspiration. + + + + +## Attribution + +This guide is based on the **contributing-gen**. +[Make your own](https://github.com/bttger/contributing-gen)! + diff --git a/README.md b/README.md index 19ab9c6..8502f98 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ A list of existing resources on R core development that we can use for reference ### Without write access -Corrections, suggestions and general improvements are welcome as [issue submissions](issues/new). +Corrections, suggestions and general improvements are welcome as [issue submissions](/issues/new). You can also suggest changes by editing the `.qmd` files that are in the `chapters/` folder at the root of this repository and submitting a pull request. Please target your pull requests to the `main` branch.