Skip to content

Commit

Permalink
feat: add Contributing page (#3148)
Browse files Browse the repository at this point in the history
  • Loading branch information
iBotPeaches committed Jul 16, 2023
1 parent df6c00f commit 86fab27
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
31 changes: 31 additions & 0 deletions docs/meta/contributing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Contributing
sidebar_position: 2
---

### Reporting Bugs

With how fast obfuscation tools and Android releases occur - the bugs stack up. When you think you've encountered one, here is what to do:

1. Search for an existing issue. If you find one, please comment with any additional information you have and/or toss a +1 reaction.
2. Create a new issue, but please follow the issue template.

It's quite crucial you follow the issue template. With the little time the maintainer(s) have, if an issue is not properly formatted, it will be closed.

### Improving the Documentation

Any large project needs a good set of documentation and Apktool is no exception.
The docs remain in the same repository on the [docs](https://github.com/iBotPeaches/Apktool/tree/docs) branch. So pull requests are welcome to grow this documentation.

### Responding to Issues

Another great way to help Apktool is to triage/respond to issues. This is a great way to get started with the project and help out fellow users.

### Fixing Bugs

As mentioned, Apktool is open source and accepts pull requests. If you have a fix for a bug, please submit a [pull request](https://github.com/iBotPeaches/Apktool/pulls).

### Suggest a Feature

While the focus for Apktool has primarily been fixing bugs, there are always new features to add.
If you have a suggestion, please create a discussion in the [Ideas](https://github.com/iBotPeaches/Apktool/discussions/categories/ideas) board.
2 changes: 1 addition & 1 deletion docs/meta/pitch.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Pitch & anti-pitch
sidebar_position: 6
sidebar_position: 1
---

Often times a question is asked - how is this different from tool xxx? This is a valid question, and one that should be asked.
Expand Down
4 changes: 4 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ const config = {
to: '/blog',
from: '/changes/',
},
{
to: '/docs/meta/contributing',
from: '/contribute/',
},
],
},
],
Expand Down

0 comments on commit 86fab27

Please sign in to comment.