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.

Sign up for GitHub

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

Jump to bottom

Conform ReadMe and create Contributing Document #262

Open
QuintinWillison opened this issue Jul 20, 2021 · 2 comments
Open

Conform ReadMe and create Contributing Document #262

QuintinWillison opened this issue Jul 20, 2021 · 2 comments
Labels
documentation Improvements or additions to public interface documentation (API reference or readme).

Comments

@QuintinWillison
Copy link
Contributor

QuintinWillison commented Jul 20, 2021 •
edited by sync-by-unito bot
Loading

In ably/ably-common#88 we have defined template layouts for README.md and CONTRIBUTING.md, hosted here.

Those documents need conforming in this repository, which necessitates the forking of the current readme content to produce the contributing guide.

This is also a good opportunity to review what's currently here.

┆Issue is synchronized with this Jira Task by Unito
@QuintinWillison
Copy link
Contributor Author

I noticed a couple of things today:

  1. The release process needs to be conformed, to include release PR step
  2. The release process needs to also include pushing tag for ably-ruby-rest and creating GitHub release from that tag over in that downstream repository also

@sync-by-unito Sync by Unito
Copy link

sync-by-unito bot commented Feb 17, 2024

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/ECO-4066

@lawrence-forooghian lawrence-forooghian added the documentation Improvements or additions to public interface documentation (API reference or readme). label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to public interface documentation (API reference or readme).
Milestone
No milestone
Development

No branches or pull requests
2 participants
@QuintinWillison @lawrence-forooghian