Unverified Commit fb18c253 authored by roadscape's avatar roadscape Committed by GitHub

Update contribution guidelines (#3391)

* unify contrib guidelines, fix #2966

* simplify guidelines

* tidy up contrib guidelines
parent 71e60cf2
......@@ -4,15 +4,11 @@ Everyone is welcome to contribute code to Steemit, Inc. projects. We have a Code
### How to contribute
1. File a Github issue describing the problem you would like to solve or the feature you would like to add. It saves unnecessary work on your part, in case there's a nontechnical reason we can't accept a particular change.
2. Learn the conventions of the project you are submitting code to, even implicit ones, and follow them. In case you have a question about a project's conventions, please ask on the issue you filed. This includes writing tests, formatting code, and documentation.
3. File a pull request against your Github issue and fill out the pull request template. Remember, you are agreeing to license your code and any intellectual property associated with your code under the same terms as the repository you are contributing to. Please note that we can and will automatically close all pull requests that do not refer to an issue.
4. If one of our teammates asks you to make changes, please make them. Our rule is that all requests for changes in code review are resolved in favor of the reviewer. Our teammates follow this rule too!
5. **Reporting Bugs**: If there is an existing feature that is not working correctly, or a glitch in the website that is impacting user behavior, please file an issue to report it. Bug reports must include, at a minimum, the following information:- the environment in which you encountered the bug. In the case of a Web application, this includes the URL, date and time of access, the name and version of the operating system and browser you’re using. In the case of a client library or other program, this includes a full stack trace as well as a representative example of the triggering code.
6. **Enhancement Suggestions**: If you have an enhancement you would like to see in Condenser, file it as an issue in this repo. Be clear in describing what problem you are trying to solve or enhancement to existing functionality you’d like to see. Our team will review your issue and offer feedback, accept it for internal development or recommend community development.
7. **Development Discussions**: The developers frequently open issues to discuss changes that are being worked on. This is to inform the community of the changes being worked on, and to get input from the community and other developers on the implementation.
8. **Pull Requests**: We love community contributions. If you've done some work on an issue and want to see it in the Condenser codebase, please submit a Pull Request, reference the issue in the description and start the title with `community -`. We're working very hard to keep our development practices as open as possible, and this helps us a lot.
9. **Translations**: Becoming a translator for your native language is easy and a great help to users around the world. To add your native language contributions for an existing or new language, please email [translate@steemit.com](mailto:translate@steemit.com) to receive your email invite. Translators are able to join existing translated languages or submit a new language. Please do not submit Pull Requests with your updates, all key string updates should always be added first in our translations platform.
1. **Reporting Bugs**: If you encounter a bug or unexpected behavior, please file an issue to report it. Please include, if possible: a description of what happened, the URL of the page, the browser you're using, a screenshot of the bug or error message, and any relevant console output.
2. **Enhancement Suggestions**: If you have an enhancement suggestion, file an issue in this repo. Be clear in describing what problem you are trying to solve or the enhancement to existing functionality you’d like to see. Our team will review your issue and offer feedback, accept it for internal development, or recommend community development.
3. **Development Discussions**: Developers may open issues to discuss proposed changes. This is to inform the community of potential changes, and to get input from the community and other developers on the implementation.
4. **Pull Requests**: We love community contributions. If you've done some work on an issue and want to see it in the Condenser codebase, please submit a Pull Request, reference the issue in the description and start the title with `community -`. We're working very hard to keep our development practices as open as possible, and this helps us a lot. PRs which include tests, format code to existing conventions, and include documentation generally receive top priority.
If one of our teammates asks you to make changes, please make them. All comments in code review must be resolved or addressed. Our teammates follow this rule too! And remember, you are agreeing to license your code and any intellectual property associated with your code under the same terms as the repository you are contributing to.
## Code of Conduct
......@@ -28,24 +24,24 @@ In the interest of fostering an open and welcoming environment, we as contributo
All members of our project and community must:
1. Show empathy toward other project and community members
2. Use welcoming and inclusive language
3. Respect differing viewpoints and experiences
4. Gracefully accept constructive criticism
1. Show empathy toward other project and community members
2. Use welcoming and inclusive language
3. Respect differing viewpoints and experiences
4. Gracefully accept constructive criticism
All members of our project and community must not:
1. Harm our project and community, or advocate harm to our project and community
2. Insult or make derogatory comments about others
3. Interact with others after they have withdrawn permission to do so
1. Harm our project and community, or advocate harm to our project and community
2. Insult or make derogatory comments about others
3. Interact with others after they have withdrawn permission to do so
### Our Responsibilities
We will use any and all lawful means at our disposal to enforce our rules. This includes but is not limited to:
1. Rejecting contributions
2. Removing comments, commits, code, wiki edits, and issues
3. Banning abusers
1. Rejecting contributions
2. Removing comments, commits, code, wiki edits, and issues
3. Banning abusers
We will clarify standards of acceptable behavior and we will take appropriate and fair corrective action in response to any instances of unacceptable behavior.
......
# steemit.com Repository FAQ
# Golden Rules
* The issue tracker is for bugs and specific implementation discussion. It
is not appropriate for product metadiscussion - it is a workroom, not a
cocktail party.
* Not every feature that spawns a drama thread on steemit.com necessarily
warrants a commit/PR. Frequently, such threads occur even when nothing is
broken or when things are working as intended. Not all problems
encountered warrant technical solutions.
* Issues opened that devolve into lengthy discussion of minor site features
will be closed or locked. The issue tracker is not a general purpose
discussion forum.
* Product improvement suggestions are encouraged, however they should be
sent to [sneak@steemit.com](mailto:sneak@steemit.com) for review.
* Working code (usually) trumps all. Requests to make changes to
steemit.com that include working, tested Pull Requests jump to the top of
the queue. (This is not a guarantee that all functionality submitted as a
PR will be merged, however.)
* For many small changes, it may be easiest to send a Pull Request *instead* of
opening an issue requesting a change be made. Anyone with a GitHub
account can search the repo, edit a file in the browser, and send in a PR.
It's easier than you might think!
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment