forked from atsign-foundation/at_python
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: README and CONTRIBUTING files updated
- Loading branch information
1 parent
35edb42
commit eb82338
Showing
2 changed files
with
27 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,31 +28,33 @@ describe. The atsign-foundation GitHub organization's conventions and configurat | |
|
||
### Prerequisites | ||
|
||
``` sh | ||
# show how to install the tools needed to work with the code here | ||
1. Download latest python from https://www.python.org/downloads/ | ||
2. Install required libraries using below command. | ||
``` | ||
pip install -r requirements.txt | ||
``` | ||
|
||
|
||
### GitHub Repository Clone | ||
|
||
To prepare your dedicated GitHub repository: | ||
|
||
1. Fork in GitHub https://github.com/atsign-foundation/REPO | ||
2. Clone *your forked repository* (e.g., `git clone [email protected]:yourname/REPO`) | ||
1. Fork in GitHub https://github.com/atsign-foundation/at_python | ||
2. Clone *your forked repository* (e.g., `git clone [email protected]:yourname/at_python`) | ||
3. Set your remotes as follows: | ||
|
||
```sh | ||
cd REPO | ||
git remote add upstream [email protected]:atsign-foundation/REPO.git | ||
cd at_python | ||
git remote add upstream [email protected]:atsign-foundation/at_python.git | ||
git remote set-url upstream --push DISABLED | ||
``` | ||
|
||
Running `git remote -v` should give something similar to: | ||
|
||
```text | ||
origin [email protected]:yourname/REPO.git (fetch) | ||
origin [email protected]:yourname/REPO.git (push) | ||
upstream [email protected]:atsign-foundation/REPO.git (fetch) | ||
origin [email protected]:yourname/at_python.git (fetch) | ||
origin [email protected]:yourname/at_python.git (push) | ||
upstream [email protected]:atsign-foundation/at_python.git (fetch) | ||
upstream DISABLED (push) | ||
``` | ||
|
||
|
@@ -90,44 +92,14 @@ To prepare your dedicated GitHub repository: | |
1. How to run tests: | ||
|
||
``` sh | ||
# explain tests here | ||
python -m unittest discover -s test -p '*_test.py' -v | ||
``` | ||
|
||
1. Open a new Pull Request to the main repository using your `trunk` branch | ||
|
||
|
||
## atLibrary release process | ||
|
||
The Atsign Foundation produces several widgets and libraries that the app developer | ||
can make use of to develop apps on atProtocol. These libraries are developed in | ||
Dart & Flutter and published to [pub.dev](https://pub.dev/publishers/atsign.org/packages). | ||
|
||
![alt_text](images/image1.png "Version flow") | ||
|
||
## Following the changes | ||
|
||
The Atsign Foundation publishes libraries and widgets to | ||
[https://pub.dev/publishers/atsign.org/packages](https://pub.dev/publishers/atsign.org/packages). | ||
Each of these libraries contains a tab called “Changelog” that shows various | ||
published versions and a short description of what changes that went in. | ||
|
||
![alt_text](images/image2.png "Changelog screenshot") | ||
|
||
Also the “Versions” tab shows the versions published in the reverse | ||
chronological order. | ||
|
||
![alt_text](images/image3.png "Versions screenshot") | ||
|
||
## Reporting a bug | ||
|
||
The best place to start reporting bugs on the libraries published by | ||
atProtocol would be the “View/report issues” link available on | ||
[pub.dev](https://pub.dev/publishers/atsign.org/packages). | ||
|
||
![alt_text](images/image4.png "View/report issues highlight") | ||
|
||
Once the link is clicked, one should be redirected to GitHub repo where the | ||
issue can be reported by clicking on the “New issue” button. | ||
Issue can be reported by clicking on the “New issue” button in the GitHub repo. | ||
|
||
![alt_text](images/image5.png "Issues list") | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,73 +1,26 @@ | ||
<img width=250px src="https://atsign.dev/assets/img/atPlatform_logo_gray.svg?sanitize=true"> | ||
|
||
# Sample README | ||
# The atPlatform for Python developers | ||
|
||
Open with intent - we welcome contributions - we want pull requests and to hear about issues. | ||
This repo contains library, samples and examples for developers who wish | ||
to work with the atPlatform from Python code. | ||
|
||
## Who is this for? | ||
## Open source usage and contributions | ||
|
||
The README should be addressed to somebody who's never seen this before. | ||
But also don't assume that they're a novice. | ||
This is open source code, so feel free to use it as is, suggest changes or | ||
enhancements or create your own version. See [CONTRIBUTING.md](./CONTRIBUTING.md) | ||
for detailed guidance on how to setup tools, tests and make a pull request. | ||
|
||
### Code user | ||
## Acknowledgement/attribution | ||
|
||
Does this repo publish to [pub.dev](https://pub.dev) or similar? | ||
In which case the code user just needs a pointer there - e.g. [at_client on pub.dev](https://pub.dev/packages/at_client) | ||
This project was originally created by [Umang Shah](https://github.com/shahumang19). | ||
|
||
### Contributor | ||
## Installation | ||
|
||
This is the person who we want working with us here. | ||
[CONTRIBUTING.md](CONTRIBUTING.md) is going to have the detailed guidance on how to setup their tools, | ||
tests and how to make a pull request. | ||
|
||
## Why, What, How? | ||
|
||
### Why? | ||
|
||
What is the purpose of this project? | ||
|
||
### What? | ||
|
||
What is needed to get the project and its dependencies installed? | ||
|
||
### How? | ||
|
||
How does this work? How is this used to fulfil its intended purpose? | ||
|
||
## Checklist | ||
|
||
### Writing | ||
|
||
Does the writing flow, with proper grammar and correct spelling? | ||
|
||
### Links | ||
|
||
Are the links to external resources correct? | ||
Are the links to other parts of the project correct | ||
(beware stuff carried over from previous repos where the | ||
project might have lived during earlier development)? | ||
|
||
### Description | ||
|
||
Has the Description field been filled out? | ||
|
||
### Acknowledgement/Attribution | ||
|
||
Have we correctly acknowledged the work of others (and their Trademarks etc.) | ||
where appropriate (per the conditions of their LICENSE? | ||
|
||
### LICENSE | ||
|
||
Which LICENSE are we using? | ||
Is the LICENSE(.md) file present? | ||
Does it have the correct dates, legal entities etc.? | ||
``` | ||
pip install -r requirements.txt | ||
``` | ||
|
||
## Maintainers | ||
|
||
Who created this? | ||
|
||
Do they have complete GitHub profiles? | ||
|
||
How can they be contacted? | ||
|
||
Who is going to respond to pull requests? | ||
This project is currently maintained by [Umang Shah](https://github.com/shahumang19) |