Skip to content

Commit

Permalink
Merge pull request #594 from eosnetworkfoundation/CONTRIBUTING_main
Browse files Browse the repository at this point in the history
[3.1 -> main] fixup CONTRIBUTING.md
  • Loading branch information
spoonincode authored Jul 5, 2022
2 parents e816432 + bb925e4 commit e73efe1
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contributing to eos
# Contributing to mandel

Interested in contributing? That's awesome! Here are some guidelines to get started quickly and easily:

- [Reporting An Issue](#reporting-an-issue)
- [Bug Reports](#bug-reports)
- [Feature Requests](#feature-requests)
- [Change Requests](#change-requests)
- [Working on eos](#working-on-eos)
- [Working on mandel](#working-on-mandel)
- [Feature Branches](#feature-branches)
- [Submitting Pull Requests](#submitting-pull-requests)
- [Testing and Quality Assurance](#testing-and-quality-assurance)
Expand All @@ -16,7 +16,7 @@ Interested in contributing? That's awesome! Here are some guidelines to get star

## Reporting An Issue

If you're about to raise an issue because you think you've found a problem with eos, or you'd like to make a request for a new feature in the codebase, or any other reason… please read this first.
If you're about to raise an issue because you think you've found a problem with mandel, or you'd like to make a request for a new feature in the codebase, or any other reason… please read this first.

The GitHub issue tracker is the preferred channel for [bug reports](#bug-reports), [feature requests](#feature-requests), and [submitting pull requests](#submitting-pull-requests), but please respect the following restrictions:

Expand All @@ -34,12 +34,12 @@ Guidelines for bug reports:
reported.

1. **Check if the issue has been fixed** — look for [closed issues in the
current milestone](https://github.com/EOSIO/eos/issues?q=is%3Aissue+is%3Aclosed) or try to reproduce it
using the latest `develop` branch.
current milestone](https://github.com/eosnetworkfoundation/mandel/issues?q=is%3Aissue+is%3Aclosed) or try to reproduce it
using the latest `main` branch.

A good bug report shouldn't leave others needing to chase you up for more information. Be sure to include the details of your environment and relevant tests that demonstrate the failure.

[Report a bug](https://github.com/EOSIO/eos/issues/new?title=Bug%3A)
[Report a bug](https://github.com/eosnetworkfoundation/mandel/issues/new?title=Bug%3A)

### Feature Requests

Expand All @@ -51,24 +51,24 @@ Feature requests are welcome. Before you submit one be sure to have:

### Change Requests

Change requests cover both architectural and functional changes to how eos works. If you have an idea for a new or different dependency, a refactor, or an improvement to a feature, etc - please be sure to:
Change requests cover both architectural and functional changes to how mandel works. If you have an idea for a new or different dependency, a refactor, or an improvement to a feature, etc - please be sure to:

1. **Use the GitHub search** and check someone else didn't get there first
1. Take a moment to think about the best way to make a case for, and explain what you're thinking. Are you sure this shouldn't really be
a [bug report](#bug-reports) or a [feature request](#feature-requests)? Is it really one idea or is it many? What's the context? What problem are you solving? Why is what you are suggesting better than what's already there?

## Working on eos
## Working on mandel

Code contributions are welcome and encouraged! If you are looking for a good place to start, check out the [good first issue](https://github.com/EOSIO/eos/labels/good%20first%20issue) label in GitHub issues.
Code contributions are welcome and encouraged! If you are looking for a good place to start, check out the [good first issue](https://github.com/eosnetworkfoundation/mandel/labels/good%20first%20issue) label in GitHub issues.

Also, please follow these guidelines when submitting code:

### Feature Branches

To get it out of the way:

- **[develop](https://github.com/EOSIO/eos/tree/develop)** is the development branch. All work on the next release happens here so you should generally branch off `develop`. Do **NOT** use this branch for a production site.
- **[master](https://github.com/EOSIO/eos/tree/master)** contains the latest release of eos. This branch may be used in production. Do **NOT** use this branch to work on eos's source.
- **[main](https://github.com/eosnetworkfoundation/mandel/tree/main)** is the development branch. All work on the next release happens here so you should generally branch off `main`. Do **NOT** use this branch for a production site.
- **release/** branches contain stable releases of mandel. Some of these branches may be obsolete, a prerelease (release candidate), or designated as stable and ready for use in production. Generally do **NOT** use these branches to work on mandel's source unless you are working on a defect or change that would apply to a current stable release or release candidate. If in doubt, branch off of `main` and a mandel maintainer will chime in if you should switch to a release branch.

### Submitting Pull Requests

Expand All @@ -78,7 +78,7 @@ Pull requests are awesome. If you're looking to raise a PR for something which d

Never underestimate just how useful quality assurance is. If you're looking to get involved with the code base and don't know where to start, checking out and testing a pull request is one of the most useful things you could do.

Essentially, [check out the latest develop branch](#working-on-eos), take it for a spin, and if you find anything odd, please follow the [bug report guidelines](#bug-reports) and let us know!
Essentially, [check out the main branch](#working-on-mandel), take it for a spin, and if you find anything odd, please follow the [bug report guidelines](#bug-reports) and let us know!

## Conduct

Expand Down

0 comments on commit e73efe1

Please sign in to comment.