diff --git a/README.md b/README.md index 9bdfc43..6cf7439 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Open Austin repo +# Open Austin repo V2 of the Open Austin website @@ -14,4 +14,8 @@ To learn about Open Austin and how to find us, visit [open-austin.org](open-aus ### How to use this repository and install the framework on your local machine -Please see the [How to use](./how_to_use.md) file for details \ No newline at end of file +Please see the [How to use](./how_to_use.md) file for details + +### How to contribute to this repository + +Please read the [Contributing doc](./docs/contributing_template.md) file for details diff --git a/docs/contributing_template.md b/docs/contributing_template.md new file mode 100644 index 0000000..2287694 --- /dev/null +++ b/docs/contributing_template.md @@ -0,0 +1,33 @@ +# Contributing: + +Please follow the issue template guideline before commiting and new pull requests + +## Guidelines: + +1. Fork the repository and set the main repository as the upstream remote + +'''git remote add upstream git@github.com:open-austin/website-v2-vercel.git''' + +2. Make a new branch with the new PR following these naming conventions: + +''' +Open-Austin/website-v2-vercel/Issue-number/name-of-issue-or-PR +''' + +3. Run tests to ensure that nothing has broken with the new upcoming PR + +4. Push to the master branch and wait for a review + + +## Making a contribution to the repo + +More info coming soon + +## Making a new issue regarding the repo + +More info coming soon + + +## Making a new feature request + +More info coming soon diff --git a/docs/issues_template.md b/docs/issues_template.md new file mode 100644 index 0000000..0a2f382 --- /dev/null +++ b/docs/issues_template.md @@ -0,0 +1,35 @@ +# List of changes made: + +- +- +- + +# Type of Issue: + +- New feature request +- Bug report-Major +- Bug report-Medium +- Bug report-Small + +# Recent issue description + + + +# Possible solution: + + + +# Step by step guide for recent PR: + +1. +2. +3. + + + +# Context of current issue: +--- + +# Your current work environment: + + diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md new file mode 100644 index 0000000..19d5ccb --- /dev/null +++ b/docs/pull_request_template.md @@ -0,0 +1,24 @@ +# List of changes made: + +- +- +- + +# Type of PR + +- New feature +- Code cleaning +- New documentation +- Bug fix (Major, Medium, Minor) +- Tests (Manual and automatic) + +## PR description + +- [] Recent PR does not interfere with app functionality +- [] Recent PR does not fail any tests + + +