Add CONTRIBUTING.md and CHANGELOG.md

modularml · Oct 5, 2024 · a0dfa82 · a0dfa82
1 parent a2af242
commit a0dfa82
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Top of tree
+* Fixed a bug with branches not being deleted when a stack is abandoned (#27).
+* Subcommands outputs is suppressed for less spammy look (#26).
+
+# Version 0.1.2
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,17 @@
+# Contributions
+
+Thank you for your interest in contributing to this project! We appreciate the time and effort you're willing to invest.
+
+## Filing Issues
+
+If you encounter bugs or have suggestions, please feel free to open an issue. Clear, detailed reports help us fix things faster!
+
+## Pull Requests (PRs)
+
+We welcome PRs for bug fixes, enhancements, and new features. Please fork the repository and submit your PR when you're ready. Be sure to check the existing issues to see if a similar change is already being worked on.
+
+Please note that the project is maintained during our team's available time, so responses and reviews might take a little longer. We will review all contributions and respond as soon as possible.
+
+When your PR is ready to be merged, one of our team members will merge it on your behalf.
+
+Thank you for contributing and helping to improve this project. We look forward to seeing your ideas!