conda-forge / conda-forge/conda-forge.github.io

Requirement of `Contributing Guidelines`

Open
#1,397 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
170
Forks
320
Avg merge
2d 10h
Merged PRs (30d)
5

Description

Just like we need Code of conduct and Reporting Guidelines, the need of a detailed *Contributing guidelines* in the Readme.md file is equally important.
Example: While contributing to this repository, one should first discuss the change one wish to make via issue with the maintainers of this repository before making a change, and to follow code of conduct, for interactions with the members .

The contributing guidelines may also include PR process, Instructions for GIT workflow.
Example:

- Git Workflow

```bash

## Step 1: Fork Repository

## Step 2: Git Set Up & Download
# Clone the repo
$ git clone https://github.com//.git
# Add upstream remote
$ git remote add upstream https://github.com/dscnitrourkela/.git
# Fetch and merge with upstream/main
$ git fetch upstream
$ git merge upstream/main

## Step 2: Create and Publish Working Branch
$ git checkout -b //{}
$ git push origin //{}

## Types:
# wip - Work in Progress; long term work; mainstream changes;
# feat - New Feature; future planned; non-mainstream changes;
# bug - Bug Fixes
# exp - Experimental; random experiemntal features;
```

we can also include the following suggestions:
- Always follow [commit message standards](https://chris.beams.io/posts/git-commit/)
- About the [fork-and-branch workflow](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.