Skip to content

Latest commit

 

History

History
91 lines (55 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

91 lines (55 loc) · 3.12 KB
Raw

Contributing to Rome

👍🎉 First of all, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Rome. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

How Can I Contribute?

How Can I Contribute?

You can contribute to Rome by reporting bugs, suggesting enhancements or making active code contributions.

Reporting Bugs

You found a bug in Rome? Great! Here's how to report it

Template For Submitting Bug Reports

[Short description of problem here]

**Reproduction Steps:**

1. [First Step]
2. [Second Step]
3. [Other Steps...]

**Expected behavior:**

[Describe expected behavior here]

**Observed behavior:**

[Describe observed behavior here]

**Problematic Romelife**
[Copy/Paste your Romefile here if this field applies]

**Problematic Cartfile.resolved**
[Copy/Paste your Cartfile.resolved here if this field applies]

**Rome version:** [Enter Rome version here]
**OS and version:** [Enter OS name and version here]

**Additional information:**

* Problem started happening recently, didn't happen in an older version of Rome: [Yes/No]
* Problem can be reliably reproduced, doesn't happen randomly: [Yes/No]
* Problem happens with all Romefile / Cartfile.resolved and projects, not only some files or projects: [Yes/No]

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Rome, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Before creating enhancement suggestions, please check this list of open issues

Template For Submitting Enhancement Suggestions

[Short description of suggestion]

**Steps which explain the enhancement**

1. [First Step]
2. [Second Step]
3. [Other Steps...]

**Current and suggested behavior**

[Describe current and suggested behavior here]

**Why would the enhancement be useful to most users**

[Explain why the enhancement would be useful to most users, list some use cases]

**Rome version:** [Enter Rome version here]
**OS and version:** [Enter OS name and version here]

Your First Code Contribution

Unsure where to begin contributing to Rome? You can start by looking through issues beginner and help-wanted:

  • Beginner issues - issues which are quite small, self contained and simple to solve
  • Help wanted issues - issues which should be a bit more involved than beginner issues.