Skip to content

Commit

Permalink
fixes #179: contribution, issue & pull-request guideline GitHub templ…
Browse files Browse the repository at this point in the history
…ates
  • Loading branch information
0x48piraj committed Apr 12, 2021
1 parent 964f3ae commit fa5e25e
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/CONTRIBUTING.md
@@ -0,0 +1,19 @@
## Contributions Best Practices

**Commits**

* Write clear meaningful git commit messages (Do read https://chris.beams.io/posts/git-commit/)
* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests )
* When you make very very minor changes to a PR of yours (like for example fixing a failing travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git )
* When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

**Feature Requests and Bug Reports**

* When you file a feature request or when you are submitting a bug report to the [issue tracker](https://github.com/saeeddhqan/Maryam/issues), make sure you add steps to reproduce it. Especially if that bug is some weird/rare one.

**Join the development**

* Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring :wink: Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
* If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

Do read the [Open Source Developer Guide](https://github.com/saeeddhqan/maryam/wiki/Development-Guide).
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,17 @@
---
Name: Feature request
About: Suggest an idea for the project

---

#### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is.

#### Describe the solution you'd like
A clear and concise description of what you want to happen.

#### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

#### Additional context
Add any other context or screenshots about the feature request here.
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,27 @@
<!--
(Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below.)
-->

<!-- Add the issue number that is fixed by this PR (In the form Fixes #123) -->

Fixes #

<!-- Short description of what this resolves -->
#### Resolves



<!-- Changes proposed in this pull request -->
#### Changes

-
-
-

#### Checklist

- [ ] I have read the Contribution & Best practices Guideline.
- [ ] My branch is up-to-date with the Upstream `master` branch.
- [ ] The acceptance, integration, unit tests pass locally with my changes <!-- use `tests/` to run all the tests -->
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)

0 comments on commit fa5e25e

Please sign in to comment.