forked from aristanetworks/ansible-cvp
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update repository documentation (aristanetworks#70)
* Update repository documentation * Symlink collection README to repo README * Update documentation * Update documentation * Apache License * Update README
- Loading branch information
Showing
4 changed files
with
136 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| # Contribute to Arista ansible-cvp collection | ||
|
|
||
|
|
||
| <!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} --> | ||
|
|
||
|
|
||
| Please take a moment to review this document in order to make the contribution | ||
| process easy and effective for everyone involved. | ||
|
|
||
| Following these guidelines helps to communicate that you respect the time of | ||
| the developers managing and developing this open source project. In return, | ||
| they should reciprocate that respect in addressing your issue or assessing | ||
| patches and features. | ||
|
|
||
| ## Using the issue tracker | ||
|
|
||
| The issue tracker is the preferred channel for [__bug reports__](#bugs), | ||
| [__features requests__](#features) and [__submitting pull | ||
| requests__](#pull-requests), but please respect the following restrictions: | ||
|
|
||
| * Please **do not** use the issue tracker for personal support requests. | ||
|
|
||
| * Please **do not** derail or troll issues. Keep the discussion on topic and | ||
| respect the opinions of others. | ||
|
|
||
| ## Bug reports | ||
|
|
||
| A bug is a _demonstrable problem_ that is caused by the code in the repository. | ||
| Good bug reports are extremely helpful - thank you! | ||
|
|
||
| Guidelines for bug reports: | ||
|
|
||
| 1. **Use the GitHub issue search** — check if the issue has already been | ||
| reported. | ||
|
|
||
| 2. **Check if the issue has been fixed** — try to reproduce it using the | ||
| latest `master` or development branch in the repository. | ||
|
|
||
| 3. **Isolate the problem** — make sure that the code in the repository is | ||
| _definitely_ responsible for the issue. | ||
|
|
||
| A good bug report shouldn't leave others needing to chase you up for more | ||
| information. Please try to be as detailed as possible in your report. | ||
|
|
||
| ## Feature requests | ||
|
|
||
| Feature requests are welcome. But take a moment to 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 developers team of the merits of this feature. Please | ||
| provide as much detail and context as possible. | ||
|
|
||
| ## Branches | ||
|
|
||
| - Current development branch: __`grant-release`__ | ||
| - Stable branch: `master` | ||
| - Branch namespace for issues: `issues/<IssueID>-<issue-name-shorten>` | ||
| - Branch namespace for Feature: `features/<IssueID>-<issue-name-shorten>` | ||
| - Branch namespace for release & development: `releases/<release_id>` | ||
|
|
||
| `master` branch is protected and only PR from a release branch could be done. All PR from `issues/` or `features/` must be directed to `release & development` branch. | ||
|
|
||
| ## Pull requests | ||
|
|
||
| Good pull requests - patches, improvements, new features - are a fantastic | ||
| help. They should remain focused in scope and avoid containing unrelated | ||
| commits. | ||
|
|
||
| **Please ask first** before embarking on any significant pull request (e.g. | ||
| implementing features, refactoring code), otherwise you risk spending a lot of | ||
| time working on something that the developers might not want to merge into the | ||
| project. | ||
|
|
||
| Please adhere to the coding conventions used throughout the project (indentation, | ||
| comments, etc.). | ||
|
|
||
| Adhering to the following this process is the best way to get your work | ||
| merged: | ||
|
|
||
| 1. [Fork](http://help.github.com/fork-a-repo/) the repo, clone your fork, | ||
| and configure the remotes: | ||
|
|
||
| ```bash | ||
| # Clone your fork of the repo into the current directory | ||
| git clone https://github.com/<your-username>/ansible-cvp | ||
| # Navigate to the newly cloned directory | ||
| cd ansible-cvp | ||
| # Assign the original repo to a remote called "upstream" | ||
| git remote add upstream https://github.com/aristanetworks/ansible-cvp.git | ||
| ``` | ||
|
|
||
| 2. If you cloned a while ago, get the latest changes from upstream: | ||
|
|
||
| ```bash | ||
| git checkout <dev-branch> | ||
| git pull upstream <dev-branch> | ||
| ``` | ||
|
|
||
| 3. Create a new topic branch (off the main project development branch) to | ||
| contain your feature, change, or fix: | ||
|
|
||
| ```bash | ||
| git checkout -b <topic-branch-name> | ||
| ``` | ||
|
|
||
| 4. Commit your changes in logical chunks. Please adhere to these [git commit | ||
| message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) | ||
| or your code is unlikely be merged into the main project. Use Git's | ||
| [interactive rebase](https://help.github.com/articles/interactive-rebase) | ||
| feature to tidy up your commits before making them public. | ||
|
|
||
| 5. Locally merge (or rebase) the upstream development branch into your topic branch: | ||
|
|
||
| ```bash | ||
| git pull [--rebase] upstream <dev-branch> | ||
| ``` | ||
|
|
||
| 6. Push your topic branch up to your fork: | ||
|
|
||
| ```bash | ||
| git push origin <topic-branch-name> | ||
| ``` | ||
|
|
||
| 10. [Open a Pull Request](https://github.com/aristanetworks/ansible-cvp/pulls) | ||
| with a clear title and description. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.