Ulysses
Ulysses Stuff => Suggestions => Topic started by: Timmy on April 04, 2018, 01:48:54 PM
-
Set guidelines for people that are interested in contributing to a Team Ulysses project.
Benefits of contribution guidelines:
- Reduces the barrier to entry for first-time contributors.
- Contributors can verify that they’re submitting well-formed pull requests and opening useful issues.
- Well-written guidelines can encourage people to contribute.
I would like to see the guidelines answer the following questions:
- Is Team Ulysses interested in receiving contributions?
- What kind of contributions are (not) welcome?
- Is there a code style contributors should adhere to?
- How can issues that need help be identified? Do they have a specific tag on GitHub?
- How do people disclose security vulnerabilities?
- How do people suggest features or enhancements?
- Can people open new issues for help or support?
- Is it okay to submit a PR for smaller issues without creating a bug report?
- When can people expect a response to their issue report or pull request?
- Which channels are used to discuss the project?
Answers to some of these questions can already be found on the forums or in the READMEs. But a single resource for all the people that are interested in contributing would be great!
Examples of contribution guidelines:
- The Atom editor contribution guidelines (https://github.com/atom/atom/blob/master/CONTRIBUTING.md).
- The Ruby on Rails contribution guidelines (https://github.com/rails/rails/blob/master/CONTRIBUTING.md).
- The Open Government contribution guidelines (https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md).
Other resources:
- Setting guidelines for repository contributors (https://help.github.com/articles/setting-guidelines-for-repository-contributors/) on GitHub Help.
- Contribution guideline template (https://github.com/nayafia/contributing-template) by nayafia.
Thank you for reading my suggestion!