Skip to content

Update CONTRIBUTING.md for wording and replaced broken links. #2167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,43 @@
# Contributing Guide

## Reporting an Issue
## First-time Contributors

The easiest way you can contribute to Amundsen is by creating issues. For that, please use the [issues][issues] section of the Amundsen repository and search for a similar bug or feature request. If you don't find it, submit your bug, question, proposal or feature request. They will remain closed until sufficient interest, e.g. 👍 reactions, has been shown by the community.
If this is your first contribution to open source, you can [follow this tutorial][contributiontutorial] or check [this video series][contributionvideos] to learn about the contribution workflow with GitHub.

## Creating Pull Requests
We always have tickets labeled ['good first issue'][goodfirstissues] and ['help wanted'][helpwantedissues]. These are a great starting point if you want to contribute. Don't hesitate to ask questions in the Amundsen Slack channel about the issue if you are not sure about the strategy to follow.

Before sending a Pull Request with significant changes, please use the [issue tracker][issues] to discuss the potential improvements you want to make.
## Reporting an Issue

## First-Time Contributors
The easiest way you can contribute to Amundsen is by creating issues. First, search the [issues][issues] section of the Amundsen repository in case a similar bug or feature request already exists. If you don't find it, submit your bug, question, proposal or feature request. They will remain closed until sufficient interest, e.g. 👍 reactions, has been shown by the community.

If this is your first contribution to open source, you can [follow this tutorial][contributiontutorial] or check [this video series][contributionvideos] to learn about the contribution workflow with GitHub.
## Creating Pull Requests

We always have tickets labeled ['good first issue'][goodfirstissues] and ['help wanted'][helpwantedissues]. These are a great starting point if you want to contribute. Don't hesitate to ask questions about the issue if you are not sure about the strategy to follow.
Before sending a pull request with significant changes, please use the [issue tracker][issues] to discuss the potential improvements you want to make. This can help us send you to a solution, a workaround, or an RFC (request for comments item in our [RFC repo][requestforcomments]).

## Requesting a Feature

We have created a [Roadmap][roadmap] document with our plans for next releases, however, we are open to hear your ideas for new features!
We have created a [community roadmap][communityroadmap] where you can vote on plans for next releases. However, we are open to hearing your ideas for new features!

For that, you can create an issue and select the "Feature Proposal" template. Fill in as much information as possible, and if you can, add responses to the following questions:

- We'll need to add a new model or change any existing model?
- What would the Migration Plan look like? Will it be backwards-compatible?
- Will we need to add a new model or change any existing model?
- What would the migration plan look like? Will it be backwards-compatible?
- Which alternatives did you consider?

## Setup

To start contributing to Amundsen, you need to set up your machine to develop with the project. For that, we have prepareda a [Developer Guide][developerguide] that will guide you to set up your environment to develop locally with Amundsen.
To start contributing to Amundsen, you need to set up your machine to develop with the project. For that, we have prepared a [developer guide][developerguide] that will guide you to set up your environment to develop locally with Amundsen.

## Next Steps

Once you have your environment set and ready to go, you can check our [documentation][documentationhomepage] and the project's [Roadmap][roadmap] to see what's coming.
Once you have your environment set and ready to go, you can check our [documentation][documentationhomepage] and the project's [community roadmap][communityroadmap] to see what's coming.

[issues]: https://github.com/amundsen-io/amundsen/issues
[contributiontutorial]: https://github.com/firstcontributions/first-contributions#first-contributions
[contributionvideos]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
[goodfirstissues]: https://github.com/amundsen-io/amundsen/labels/good%20first%20issue
[helpwantedissues]: https://github.com/amundsen-io/amundsen/labels/help%20wanted
[goodfirstissues]: https://github.com/amundsen-io/amundsen/issues?q=label%3A%22good+first+issue%22+-label%3Anot%22status%3Acompleted%22+
[helpwantedissues]: https://github.com/amundsen-io/amundsen/issues?q=label%3A%22help+wanted%22++-label%3Anot%22status%3Acompleted%22+
[developerguide]: https://www.amundsen.io/amundsen/developer_guide/
[roadmap]: https://www.amundsen.io/amundsen/roadmap/
[communityroadmap]: https://github.com/amundsen-io/amundsen#community-roadmap
[documentationhomepage]: https://www.amundsen.io/amundsen/
[requestforcomments]: https://github.com/amundsen-io/rfcs