From f054e5772a3d0c5b93d9d45337d2721dfeaa60e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodrigo=20L=C3=B3pez=20Dato?= Date: Tue, 23 Apr 2024 12:03:42 -0300 Subject: [PATCH] docs: misc README improvements * Rename Readme.md to standard README.md * Add CONTRIBUTING.md in this repository instead of an external gist * Link to SDK docs with Python already selected --- CONTRIBUTING.md | 17 +++++++++++++++++ Readme.md => README.md | 4 ++-- 2 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md rename Readme.md => README.md (80%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..87bd0e6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +We're always looking to improve this project, open source contribution is encouraged so long as they adhere to these +guidelines. + +## Pull Requests + +The Flagsmith team will be monitoring for pull requests. When we get one, a member of team will test the work against +our internal uses and sign off on the changes. From here, we'll either merge the pull request or provide feedback +suggesting the next steps. + +### A couple things to keep in mind + +- If you've changed APIs, update the documentation. +- Keep the code style (indents, wrapping) consistent. +- If your PR involves a lot of commits, squash them using `git rebase -i` as this makes it easier for us to review. +- Keep lines under 80 characters. diff --git a/Readme.md b/README.md similarity index 80% rename from Readme.md rename to README.md index addfa5c..2df3a1b 100644 --- a/Readme.md +++ b/README.md @@ -10,11 +10,11 @@ The SDK for Python applications for [https://www.flagsmith.com/](https://www.fla ## Adding to your project For full documentation visit -[https://docs.flagsmith.com/clients/server-side](https://docs.flagsmith.com/clients/server-side). +[https://docs.flagsmith.com/clients/server-side?language=python](https://docs.flagsmith.com/clients/server-side?language=python). ## Contributing -Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests ## Getting Help