#36 Initial version of the How to start documentation
Closed 6 years ago by psss. Opened 6 years ago by psss.
fedora-ci/ psss/AtomicCi start  into  master

file added
+75
@@ -0,0 +1,75 @@ 

+ ## Contributing tests for Fedora Atomic Host CI

+ 

+ ### Documentation and Account

+ 

+ To start contributing you should read the following pages in the

+ first place:

+ 

+  * https://fedoraproject.org/wiki/Changes/InvokingTests

+  * https://fedoraproject.org/wiki/CI/Tests#Testing_an_Atomic_Host

+ 

+ Make sure you have a FAS account. You can also find useful

+ information and tools related to working with packages in the

+ Package maintenance guide:

+ 

+  * https://admin.fedoraproject.org/accounts/user/new

+  * https://fedoraproject.org/wiki/Package_maintenance_guide

+ 

+ ### Adding Tests

+ 

+ Clone repositories with tests and project code, run the tests:

+ 

+  * Clone tests from https://upstreamfirst.fedorainfracloud.org/

+  * [Run them](https://fedoraproject.org/wiki/CI/Tests#Testing_an_Atomic_Host)

+    and make sure sure that all tests with Atomic tag are Passed.

+  * Clone project from https://src.fedoraproject.org/browse/projects/

+ 

+ Include tests into the project:

+ 

+  * Move tests into the project folder.

+  * Rename folder with tests to "tests".

+  * Make sure there are no ** \*.log ** files inside.

+  * Don't forget to delete the **.git/** folder.

+  * Make changes, create a new git branch, eg. `git checkout -b new_tests`.

+  * Commit (include links to the project in the commit links).

+ 

+ Example Commit Message:

+ 

+     Add CI tests using the standard test interface

+ 

+     Adding tests according to the CI wiki [0] and standard test interface [1]

+     [0] https://fedoraproject.org/wiki/CI

+     [1] https://fedoraproject.org/wiki/Changes/InvokingTests

+ 

+ ### Pull Request

+ 

+ Unless you are a Fedora packager follow instructions for creating a public git repo on

+ [fedorapeople](https://fedoraproject.org/wiki/Infrastructure/fedorapeople.org#fedora_people_git_hosting_support)

+ and upload package folder there:

+ 

+ ```sh

+ scp -r <package> @fedorapeople.org:public_git/

+ ```

+ Navigate to the [fedoraproject.org](https://src.fedoraproject.org/rpms/pam/pull-requests).

+ Press **File Pull Request** button then press **Remote pull request**.

+ 

+ ![](https://cdn.pbrd.co/images/GNvkC6F.png)

+ 

+ Fill the required fields:

+ 

+  * **Title:** *Add CI tests using the standard test interface*

+  * **Git repo address:** *git://fedorapeople.org/~<username>/<package folder>*

+  * **Git branch:** *new_tests*

+  * **To branch:** *master*

+ 

+ ![](https://cdn.pbrd.co/images/GNvlULn.png)

+ 

+  * Press the **Preview** button.

+  * Add **Initial Comment** with tests results, for example:

+ 

+ ### Initial Comment

+ ***

+ ![Initial Comment](https://cdn.pbrd.co/images/GNvbmFl.png)

+ ***

+ 

+ Make sure you mentioned right maintainer contact person.

Draft created by Serhii Turivnyi.

have to -> should?

Well, that's only true for the ones that RH has decided to open-source, people can add any tests they want :)

I'm not sure most of these steps are needed, are they?

Maybe we should explain why/how this is a workaround

Aren't we focusing on the Atomic tests?

Hm, seems the links are not working...

1 new commit added

  • Fix links & wording
6 years ago

2 new commits added

  • Fix links, use bullets to better structure steps
  • Initial version of the How to start documentation
6 years ago

1 new commit added

  • Clarify the pull request, some adjustments
6 years ago

Pull-Request has been closed by psss

6 years ago
Metadata
Changes Summary 1