Skip to content

Latest commit

 

History

History
70 lines (53 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

70 lines (53 loc) · 4.05 KB
Raw

Contributing to Devopness

Thank you for considering contributing to Devopness!

We appreciate the help!

All community contributions are welcome! Being them:

Not ready to start contributing?

No problem! If you like Devopness, but just don't have time to contribute yet, that's fine. There are other easy ways to support Devopness and show your appreciation:

  • ⭐ Star this repository
  • 📣 Post about Devopness on social networks, Discord, LinkedIn, Slack, Twitter, ...

Code of Conduct

Please make sure to read and observe our Contributor Code of Conduct.

Contributing Guidelines

Getting Started

Good first issues are a great way to start contributing to the project and get familiar with the codebase. Here's how to find them:

  1. Visit the "Issues" tab on the main repository
  2. Use the "Labels" filter and select "Good First Issue" to see a list of beginner-friendly tasks
  3. Choose an issue that interests you

Forking this repository

  1. Fork the repository and start working on it
  2. To become familiar working with forks, please read and follow the standard fork based workflow, which could be summarized with the following steps:
  • Fork Devopness repository
  • Create a branch
  • When the changes in a branch are tested, open a pull request from your fork

Submitting a Pull Request

  1. Once you implemented a new feature or a fix for an issue, open a pull request for review
  • Please ensure all automated checks on your PR are passing, otherwise the PR will not be considered ready to be reviewed
  1. Code Review: Your pull request will be reviewed
  • Note: you might need to make changes on your pull request based on reviewers's feedbacks
  1. Merge: Once approved, maintainers will merge your pull request into the main repository branch

Pull request title are the changelog messages

The messages that appear in our changelogs are the messages defined as titles of the pull requests.

Pull request titles should:

  • be written in the active imperative form
  • not end with a period (.)
  • be read in natural language. As a simple rule one can pretend the message in a pull request title starts with "This change will ..."
    • Example: for a pull request that has the title fix broken links on user profile page, it could be read as This change will ... fix broken links on user profile page

Here are some bad examples of pull requests titles we're trying to avoid:

  • Fixes a bug
  • Adds a feature
  • Feature now does something

Feature Work

For larger features, we would appreciate it if you open a new issue before investing a lot of your time trying to solve it, so we can discuss and plan the feature together.

Please also be sure to browse current issues to make sure your issue is unique, to lighten the triage burden on our maintainers. Finally, please limit your pull requests to contain only one feature at a time. Separating feature work into individual pull requests helps speed up code review and reduces the barrier to merge.

Getting Help

If you want to talk with other folks in the Devopness community (including members of the Devopness team) please start a discussion and we will soon get in touch with you.