-
Notifications
You must be signed in to change notification settings - Fork 496
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
Conversation
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
There was a problem hiding this 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.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/issues
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯
There was a problem hiding this 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The issues URL is https://github.com/gomods/athens/issues
There was a problem hiding this comment.
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!
There was a problem hiding this 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💪
I'm going to merge this since it's documentation and has 2 approvals |
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.
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.