Skip to content
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

Improving the project status section of our README #1555

Merged
merged 14 commits into from
Mar 18, 2020

Conversation

arschles
Copy link
Member

@arschles arschles commented Feb 25, 2020

What is the problem I am trying to address?

Athens is not really "beta" anymore because teams are using it and we are already taking backward compatibility into consideration actively.

How is the fix applied?

I've changed the language in the section that says the project is beta.

Note: I believe that the version number is a different but related discussion that we should have.

I've also updated the contributing documentation and removed the section about dev meetings, because we don't have them anymore.

Mention the issue number it fixes or add the details of the changes if it doesn't have a specific issue.

Athens is not really "beta" anymore because teams are using it and we are already taking backward compatibility into consideration actively.

I believe that the version number is a different but related discussion that we should have.

I've also updated the contributing documentation and removed the section about dev meetings
@arschles arschles requested a review from a user February 25, 2020 19:27
@arschles arschles requested a review from a team as a code owner February 25, 2020 19:27
@arschles arschles mentioned this pull request Feb 26, 2020
6 tasks
Copy link
Collaborator

@twexler twexler left a comment

Choose a reason for hiding this comment

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

One small thing, otherwise looks good.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@arschles
Copy link
Member Author

Thanks @twexler - I updated according to your comment 💚

README.md Outdated

If you decide to contribute (we hope you do :smile:), the process is familiar and easy if you've used Github before. There are no long documents to read or complex setup. If you haven't used Github before, the awesome [@bketelsen](https://github.com/bketelsen) has created a good overview on how to contribute code - see [here](https://www.youtube.com/watch?v=bgSDcTyysRc).
>We do recommend that you choose one of the issues on the above list, but you may also consider a different issue from our [entire issue list](https://github.com/gomods/athens). Many of the issues on that list are more complex and challenging.
Copy link

Choose a reason for hiding this comment

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

/issues

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch, fixed. Thanks @robjloranger

Copy link
Collaborator

@twexler twexler left a comment

Choose a reason for hiding this comment

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

💯

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Other than the URL for issues 👍

README.md Outdated

If you decide to contribute (we hope you do :smile:), the process is familiar and easy if you've used Github before. There are no long documents to read or complex setup. If you haven't used Github before, the awesome [@bketelsen](https://github.com/bketelsen) has created a good overview on how to contribute code - see [here](https://www.youtube.com/watch?v=bgSDcTyysRc).
>We do recommend that you choose one of the issues on the above list, but you may also consider a different one from our [entire list](https://github.com/gomods/athens). Many of the issues on that list are more complex and challenging.
Copy link

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

@robjloranger good catch, thanks. Fixed!

Copy link

@geototti21 geototti21 left a comment

Choose a reason for hiding this comment

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

I love this, especially the removal of experimental tag💪

@arschles
Copy link
Member Author

I'm going to merge this since it's documentation and has 2 approvals

@arschles arschles merged commit 99867c7 into gomods:master Mar 18, 2020
@arschles arschles deleted the status branch March 18, 2020 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants