Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added a little bit more information on tag shuffling to CONTRIBUTING.md

  • Loading branch information...
commit 5010b7a6ecd4322a5dfa835de92f38e9eb88adf0 1 parent b44768c
@yrashk yrashk authored
Showing with 14 additions and 1 deletion.
  1. +14 −1 CONTRIBUTING.md
View
15 CONTRIBUTING.md
@@ -14,5 +14,18 @@ and later on submitting it for inclusion by [opening an issue](https://github.co
The last step is only necessary if you want this package to be published on a "central" index.
If you want to keep it semi-private, you can just use it from your own index.
+
+Mastering specification
+-----------------------
+
+First of all, please take some time to read through [README](agner#readme) to make sure you understand all the concepts,
+especially how versioning is done.
+
+Also, even though in Git world you can be crucified for deleting remote tags (`release` versions in our lingo), in Agner,
+even not encouraged, this type of action is tolerable if you need to change the specification of an already published release.
+`.agner` repos are intended for quick fresh cloning so shuffling tags in them is not that critical. If you do anticiapte anticipate that somebody has a fork of your `.agner` repo, though, please communicate your tag changes to them, just in case. One of
+the ways might be adding some README or NOTES file into your `.agner` repo.
+
Before commiting your agner.config, please make sure you ran `agner verify` on it so it passes at least
-some validity checks.
+some validity checks.
+
Please sign in to comment.
Something went wrong with that request. Please try again.