Skip to content

Commit

Permalink
Adds numbering to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
manoelcampos committed Jun 13, 2022
1 parent cef1d03 commit ac01a8c
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Contributions are always welcome and they speed up the simulator evolution. You
However, to maintain a high project quality, there are a few guidelines we need contributors to follow. This way we can have a chance of keeping on top of things.
These guidelines are mainly relevant when you are planning to contribute to the project's source code, so that code quality is preserved and [software rot](https://en.wikipedia.org/wiki/Software_rot) is avoided.

# Ways You Can Contribute
# 1. Ways You Can Contribute

1. Clicking on the "Star" button at the top of the project's GitHub page, giving us more visibility.
1. Using CloudSim Plus at your academic work and citing us in your publications. See the [Publications Section](https://cloudsimplus.org/#publications) for more information.
Expand All @@ -16,35 +16,35 @@ These guidelines are mainly relevant when you are planning to contribute to the

The sections below present more information on how to contribute in some of these ways.

# Getting Started
# 2. Getting Started

If you want to contribute in some of the 3 last ways presented above, please follow these instructions:

1. Make sure you have a [GitHub account](https://github.com/signup/free)
1. [Check if you are using the latest development version of CloudSim Plus](http://cloudsimplus.readthedocs.io/en/latest/syncing-you-fork-or-clone.html).
1. Submit a [ticket for your issue](https://github.com/manoelcampos/cloudsimplus/issues), assuming one does not already exist. Check the next sub-section for more details.

## Requesting a Feature or Reporting an Issue
## 2.1. Requesting a Feature or Reporting an Issue

If you just want to request a feature or report an issue, look if the issue/feature you want to report/request hasn't been reported/requested yet at the [issues page](https://github.com/manoelcampos/cloudsimplus/issues). Try checking the existing issues/features and search using some keywords before creating a new ticket. You can also check the [Google Groups Forum](https://groups.google.com/group/cloudsim-plus) to see if there is any discussion about the subject. If the issue/feature has not been created in the issues page yet, feel free to create a ticket there.

If you are planing to fix an issue or implement a feature, after reporting it, we recommend you to firstly discuss the subject at the [Google Groups Forum](https://groups.google.com/group/cloudsim-plus) and your proposed implementation. This is important to make other users and the CloudSim Plus team to know what you are planning to do and to avoid simultaneous work on the same issues/features.

Finally, when submitting a ticket, please read carefully the information at the submission form and make sure each issue is related to a single bug/feature.

## Fixing a Bug or Implementing a New Feature
## 2.2. Fixing a Bug or Implementing a New Feature

Before fixing a bug of implementing a new feature, you have to first fork the repository on GitHub. You can fix a bug or implement a feature already reported by other user or by yourself at the issues page, as mentioned in the previous section.

### 1. Create a Topic Branch for You to Work on
### 2.2.1. Create a Topic Branch for You to Work on

Create a topic branch from where you want to base your work.
* This is usually the master branch.
* Only target specific release branches (such as a branch named "cloudsim-plus-1.0.1") if you are certain that your fix must be on that branch.
* To quickly create a topic branch based on master: `git checkout master -b my_contribution`.
Please avoid working directly on the `master` branch.

### 2. Follow These Code Quality Guidelines
### 2.2.2. Follow These Code Quality Guidelines

The last step before you start coding is to follow the guidelines below, so that your contribution is likely to be merged in the CloudSim Plus code:

Expand Down Expand Up @@ -74,7 +74,7 @@ The last step before you start coding is to follow the guidelines below, so that
by means of [EditorConfig IDE Plugins](http://editorconfig.org).
You are not required to use it, but at least, use the "auto format" option of your IDE to tidy the code after you finish working.

### 3. Commit Your Changes
### 2.2.3. Commit Your Changes

* Check for unnecessary whitespace with `git diff --check` before committing.
* Spend a little time to write good, informative and structured commit messages, describing clearly what you have done. Take the template below as an example:
Expand All @@ -93,16 +93,14 @@ The last step before you start coding is to follow the guidelines below, so that
* Run _all_ the tests to assure nothing else was accidentally broken.
* Changes that don't have a set of unit tests or that break existing tests **will not** be accepted.

### 4. Submit Your Changes
### 2.2.4. Submit Your Changes

* [Rebase your changes on top of CloudSim Plus master branch at the official repository](https://robots.thoughtbot.com/git-interactive-rebase-squash-amend-rewriting-history#rebase-on-top-of-master) so that you will get the most recent development version and perform any merge conflicts that may happen.
* [Commit the final changes including something such as "Closes #NUMBER_OF_THE_ISSUE" or "Fixes #NUMBER_OF_THE_ISSUE"](https://help.github.com/articles/closing-issues-via-commit-messages/) in order to reference the issue in which you were working on.
* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the official CloudSim Plus repository.
* Wait for your contribution to be assessed and thanks in advance for contributing.

# Credits

This Contribution Guide was based on [Puppet guide](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md),
recommend by the [Friction tool](https://github.com/rafalchmiel/friction).
The current guide was adapted and improved to follow CloudSim Plus required standards.
> **Note**
> This Contribution Guide was based on [Puppet guide](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md),
> recommend by the [Friction tool](https://github.com/rafalchmiel/friction). It was adapted and improved to follow CloudSim Plus required standards.

0 comments on commit ac01a8c

Please sign in to comment.