From 694212cce8d5538ace1e86096c0eb93907b947e5 Mon Sep 17 00:00:00 2001 From: Marien Fressinaud Date: Tue, 3 Feb 2015 15:57:33 +0100 Subject: Create CONTRIBUTING.md file See https://github.com/FreshRSS/FreshRSS/issues/783 --- CONTRIBUTING.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..fb1610a1f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# How to contribute to FreshRSS? + +## Report a bug + +You found a bug? Don't panic, here are some steps to report it easily: + +1. Search for it on [the bug tracker](https://github.com/FreshRSS/FreshRSS/issues) (don't forget to use the search bar). +2. If you find a similar bug, don't hesitate to post a comment to add more importance to the related ticket. +3. If you didn't find it, [open a new ticket](https://github.com/FreshRSS/FreshRSS/issues/new). + +If you have to create a new ticket, try to apply the following advices: + +- Give an explicit title to the ticket so it will be easier to find it later. +- Be as exhaustive as possible in the description: what did you do? What is the bug? What are the steps to reproduce the bug? +- We also need some information: + + Your FreshRSS version (on about page or `constants.php` file) + + Your server configuration: type of hosting, PHP version + + Your storage system (MySQL / MariaDB or SQLite) + + If possible, the related logs (PHP logs and FreshRSS logs under `data/users/your_user/log.txt`) + +## Fix a bug + +Did you want to fix a bug? To keep a great coordination between collaborators, you will have to follow these indications: + +1. Be sure the bug is associated to a ticket and say you work on it. +2. Fork the FreshRSS repository. +3. Get your repository `git clone -b dev git@github.com:your_username/FreshRSS.git && cd FreshRSS` +4. It's better to create a dedicated branch to fix your bug: the name of the branch must be explicit and being prefixed by the related ticket id. For instance, `783-contributing-file` to fix [ticket #783](https://github.com/FreshRSS/FreshRSS/issues/783). +5. Once you'll have finished, commit your work, push your branch upstream (`git push --set-upstream origin your_branch_name`) and do a [pull request](https://github.com/FreshRSS/FreshRSS/compare) on the **dev branch**. +6. Wait and see. + +If you have to write code, please follow [our coding style recommendations](http://doc2.freshrss.org/en/Developer_documentation/First_steps/Coding_style). + +**Tip:** if you are searching for bugs easy to fix, have a look at the « [New comers](https://github.com/FreshRSS/FreshRSS/labels/New%20comers) » ticket label. + +## Submit an idea + +You have great ideas, yes! Don't be shy and open [a new ticket](https://github.com/FreshRSS/FreshRSS/issues/new) on our bug tracker to ask if we can implement it. The greatest ideas often come from the shyest suggestions! + +If your idea is nice, we'll have a look at it. + +TODO: complete + +## Contribute to internationalization (i18n) + +If you want to improve internationalization, please open a new ticket first and follow indications from « Fix a bug » section. + +TODO: finish + +We are working on a better way to handle internationalization. + +## Contribute to documentation + +The documentation needs a lot of improvements in order to be more useful to new contributors and we are working on it. If you want to give some help, meet us on [the dedicated repository](https://github.com/FreshRSS/documentation)! + +TODO: finish -- cgit v1.2.3 From ee56f3607df3f6f31082b1f86d89e9b705dc93c8 Mon Sep 17 00:00:00 2001 From: Marien Fressinaud Date: Tue, 17 Feb 2015 14:45:26 +0100 Subject: Improve CONTRIBUTING file - remove TODO - simplify info about "fix a bug" (get from https://github.com/github/gitignore README) - add few info See https://github.com/FreshRSS/FreshRSS/issues/783 --- CONTRIBUTING.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb1610a1f..a80664f67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,11 +23,9 @@ If you have to create a new ticket, try to apply the following advices: Did you want to fix a bug? To keep a great coordination between collaborators, you will have to follow these indications: 1. Be sure the bug is associated to a ticket and say you work on it. -2. Fork the FreshRSS repository. -3. Get your repository `git clone -b dev git@github.com:your_username/FreshRSS.git && cd FreshRSS` -4. It's better to create a dedicated branch to fix your bug: the name of the branch must be explicit and being prefixed by the related ticket id. For instance, `783-contributing-file` to fix [ticket #783](https://github.com/FreshRSS/FreshRSS/issues/783). -5. Once you'll have finished, commit your work, push your branch upstream (`git push --set-upstream origin your_branch_name`) and do a [pull request](https://github.com/FreshRSS/FreshRSS/compare) on the **dev branch**. -6. Wait and see. +2. [Fork this project repository](https://help.github.com/articles/fork-a-repo/). +3. [Create a new branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/). The name of the branch must be explicit and being prefixed by the related ticket id. For instance, `783-contributing-file` to fix [ticket #783](https://github.com/FreshRSS/FreshRSS/issues/783). +4. Make your changes to your fork and [send a pull request](https://help.github.com/articles/using-pull-requests/) on the **dev branch**. If you have to write code, please follow [our coding style recommendations](http://doc2.freshrss.org/en/Developer_documentation/First_steps/Coding_style). @@ -39,18 +37,16 @@ You have great ideas, yes! Don't be shy and open [a new ticket](https://github.c If your idea is nice, we'll have a look at it. -TODO: complete - ## Contribute to internationalization (i18n) If you want to improve internationalization, please open a new ticket first and follow indications from « Fix a bug » section. -TODO: finish +Translations are present in the subdirectories of `./app/i18n/`. -We are working on a better way to handle internationalization. +We are working on a better way to handle internationalization but don't hesitate to suggest any idea! ## Contribute to documentation The documentation needs a lot of improvements in order to be more useful to new contributors and we are working on it. If you want to give some help, meet us on [the dedicated repository](https://github.com/FreshRSS/documentation)! -TODO: finish +The best is to open tickets to ask your questions or to do any suggestions. -- cgit v1.2.3 From 3aec3e717173713d6a817110fb61b3702c929b1d Mon Sep 17 00:00:00 2001 From: Marien Fressinaud Date: Tue, 17 Feb 2015 14:52:18 +0100 Subject: Improve CONTRIBUTING.md file Add a section about mailing lists See https://github.com/FreshRSS/FreshRSS/issues/783 --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a80664f67..3f72c5cd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,12 @@ # How to contribute to FreshRSS? +## Join us on the mailing lists + +Do you want to ask us some questions? Do you want to discuss with us? Don't hesitate to subscribe to our mailing lists! + +- The first mailing is destined to generic information, it should be adapted to users. [Join mailing@freshrss.org](https://freshrss.org/mailman/listinfo/mailing). +- The second mailing is mainly for developers. [Join dev@freshrss.org](https://freshrss.org/mailman/listinfo/dev) + ## Report a bug You found a bug? Don't panic, here are some steps to report it easily: -- cgit v1.2.3 From e7a35161e29b3319ff3c0956c3de671735cd6d9a Mon Sep 17 00:00:00 2001 From: Marien Fressinaud Date: Wed, 18 Feb 2015 16:05:55 +0100 Subject: Update CONTRIBUTING file Remove unnecessary sentences in "Contribute to documentation" See https://github.com/FreshRSS/FreshRSS/issues/783 --- CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f72c5cd7..133813711 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,5 +55,3 @@ We are working on a better way to handle internationalization but don't hesitate ## Contribute to documentation The documentation needs a lot of improvements in order to be more useful to new contributors and we are working on it. If you want to give some help, meet us on [the dedicated repository](https://github.com/FreshRSS/documentation)! - -The best is to open tickets to ask your questions or to do any suggestions. -- cgit v1.2.3