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

Fix docs and add contributing guide #475

Merged
merged 4 commits into from
Jan 27, 2022
Merged

Conversation

samutamm
Copy link
Contributor

  • Fix typo in docs
  • Add CONTRIBUTING.md guide

Samu Tamminen and others added 2 commits January 21, 2022 08:59
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Bomin Zhang <[email protected]>
Copy link
Contributor

@suchen-sci suchen-sci left a comment

Choose a reason for hiding this comment

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

add CONTRIBYTING.md to README.md?

Copy link
Contributor

@haoel haoel left a comment

Choose a reason for hiding this comment

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

Two optional comments

  1. I think we can add a contact-us link (our slack) if people need the help instantly.
  2. add this document link to README.md

@samutamm
Copy link
Contributor Author

1. I think we can add a contact-us link (our slack) if people need the help instantly.

There's already link to README.md part that contains the Slack link. I think it's better to have the link in one place so it's easier to keep up-to-date

@samutamm samutamm merged commit 7fb867a into easegress-io:main Jan 27, 2022
@samutamm samutamm deleted the fix-docs branch January 27, 2022 00:46
samutamm pushed a commit to samutamm/easegress that referenced this pull request Jan 27, 2022
* fix typo and add example for requestAdaptor.Path

* Add contributing guide

Co-authored-by: SU Chen <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Yun Long <[email protected]>

* Update CONTRIBUTING.md

Co-authored-by: Bomin Zhang <[email protected]>

* fix typo and add link to contributing.md to README.md

Co-authored-by: SU Chen <[email protected]>
Co-authored-by: Hao Chen <[email protected]>

Co-authored-by: SU Chen <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Yun Long <[email protected]>
Co-authored-by: Bomin Zhang <[email protected]>
Co-authored-by: Hao Chen <[email protected]>
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.

None yet

4 participants