Skip to content

Commit

Permalink
Create a contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
GreaterFire committed Feb 16, 2020
1 parent c3a17f2 commit 60ab4af
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: GreaterFire

---

- [ ] I certify that I acknowledge if I don't follow the format below, or I'm using an old version of trojan, or I apparently fail to provide sufficient information (such as logs, specific numbers), or I don't check this box, my issue will be closed immediately without any notice.
- [ ] I certify that I have read the contributing guidelines and I acknowledge if I don't follow the format below, or I'm using an old version of trojan, or I apparently fail to provide sufficient information (such as logs, specific numbers), or I don't check this box, my issue will be closed immediately without any notice.

**Trojan Version**
The version of trojan you are using.
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: GreaterFire

---

- [ ] I certify that I acknowledge if I don't follow the format below or I don't check this box, my issue will be closed immediately without any notice.
- [ ] I certify that I have read the contributing guidelines and I acknowledge if I don't follow the format below or I don't check this box, my issue will be closed immediately without any notice.

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Expand Down
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing

I want to first thank you for your interests in contributing to the Trojan project. Your contributions are much appreciated. To ensure an effective and efficient communication environment, here are some guidelines you should adhere to when you are considering contributing.

## Issues

Issues in this repository are for bug reports and feature requests, and for these purposes **only**. Irrelevant content, such as usage problems or server configuration issues, should not be discussed here. The developers will, at their discretion, either answer or ignore and close this kind of issues without any notice. The **required** communication language in this repository is English.

If you would like to file a bug report, you **must** use the bug report template and follow the instructions inside it. If you do not do so, or if the problem you reported is not considered by the developers a bug, your issue might be closed immediately.

If you would like to file a feature request, you also **must** use the feature request template and follow the instructions inside it. Note that we are trying to keep this project as small as possible because it is the core of the trojan ecosystem and will be included in other projects. For a feature to be considered, make sure that the feature you request is **really necessary** to be included in this very project. Also, we will not consider adding a dependency to the project unless it is **absolutely necessary**. If you do not do the above, your issue might be closed immediately.

## Pull Requests

Pull requests are very welcomed. However, due to the reasons we just talked about, we will only accept features that are **really necessary** for this project. Bug fixes and security-related fixes have more chances to be reviewed by the developers.

For contributors who make frequent and high-quality contributions, there is a chance that they'll be invited to join our organization.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ Trojan is not a fixed program or protocol. It's an idea, an idea that imitating
An online documentation can be found [here](https://trojan-gfw.github.io/trojan/).
Installation guide on various platforms can be found in the [wiki](https://github.com/trojan-gfw/trojan/wiki/Binary-&-Package-Distributions).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## Dependencies

- [CMake](https://cmake.org/) >= 3.7.2
Expand Down

2 comments on commit 60ab4af

@Liuhanghai
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md

@Liuhanghai
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.github/ISSUE_TEMPLATE/bug_report.md

Please sign in to comment.