diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..5e114863e9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +Contributing to Mayan EDMS +========================== + +Issues +------ + +- Before submitting a new issue, check for **open issues** first and join the +discussion. +- If your issue is not attended in a while, **be patient**, the core team is +small and the codebase big. +- Try to reproduce the issue using a **separate, clean installation**, sometimes +the issue can be caused by an error in a configuration file and not with the +code itself. +- **Do not upload** sensitive, private or classified information or files with +your issue. If the issue is triggered by a user file, create a dummy file with the +same properties that can trigger the issue and upload that file instead. +- Add steps that trigger the issue in a **repeatable manner**. +- **Screenshots** go a long way in helping understand problems. +- The issue must be related to the code only, do not open issues for problems +with webservers, cloud providers, etc. +- Do not open issues asking for **support or consulting**. + +Code +---- + +1. Fork [the repository](http://gitlab.com/mayan-edms/mayan-edms). +1. Choose the version for which you want to develop. The code is divided in the +following branches: + + a. **master:** Current stable version. + a. **series/X.Y:** There will be a **series** branch for each major version + release (1.0, 2.0). The **master** branch will be in sync with the latest + **series** branch. + a. **development:** Unstable branch where the development for the next minor or + major release is happening. + a. **feature/X:** These are branches dealing with a specific bug or feature + that is not yet ready to be merged. + a. The **master** and **series** branches are stable and not braking changes + must be submitted or merged. The **development** and **feature** branches + are unstable and should not be used in production. + +1. Start making your changes in your own separate branch. +1. Write a test which shows that the bug was fixed or that the feature works as expected. +1. Submit a merge request for your changes. + +Feature requests +---------------- + +- Opening issues to start a discussion around a new feature or idea are welcomed. +- Be explicit about your idea and provide a simple scenario, others need to really +understand the concepts behind your idea if it is to be implemented. +- Be realistic in your expectation and scope of your idea. + +Translations +------------ +- Translations are handled using [Transifex](https://www.transifex.com/rosarior/mayan-edms/). +- Join an existing team for the language to which you wish to contribute, +if there is no team for your language, request for one to be created. +- Don't request the creation of a new language and expect others to do all the +work. If you request the creation of a new language try to do some of the +translation. Language teams that don't see activity for a while are deleted. + +Code style +---------- +- Refer to the [Development](http://mayan.readthedocs.io/en/latest/topics/development.html) +chapter for information and examples of the code style. + +License +------- +By contributing your code, you agree to license your contribution under the +terms of the project's license. diff --git a/README.rst b/README.rst index 37edc4c352..925421158a 100644 --- a/README.rst +++ b/README.rst @@ -40,14 +40,7 @@ To install Mayan EDMS, simply do: Point your browser to 127.0.0.1:8000 and use the automatically created admin account. -Contribute ----------- -- Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. -- Fork `the repository`_ on GitLab to start making your changes to the **development** branch (or branch off of it). -- Write a test which shows that the bug was fixed or that the feature works as expected. -- Add yourself to the `contributors file`_. -- Send a merge request. .. _Website: http://www.mayan-edms.com @@ -56,8 +49,6 @@ Contribute .. _Translations: https://www.transifex.com/projects/p/mayan-edms/ .. _Mailing list (via Google Groups): http://groups.google.com/group/mayan-edms .. _Apache 2.0 License: https://www.apache.org/licenses/LICENSE-2.0.txt -.. _`the repository`: http://gitlab.com/mayan-edms/mayan-edms -.. _`contributors file`: https://gitlab.com/mayan-edms/mayan-edms/blob/master/docs/topics/contributors.rst .. |Build Status| image:: https://gitlab.com/mayan-edms/mayan-edms/badges/master/build.svg :target: https://gitlab.com/mayan-edms/mayan-edms/commits/master diff --git a/docs/topics/development.rst b/docs/topics/development.rst index 5654918326..46fcf90bd4 100644 --- a/docs/topics/development.rst +++ b/docs/topics/development.rst @@ -6,8 +6,8 @@ Development Mayan EDMS is under active development, and contributions are welcome. If you have a feature request, suggestion or bug report, please open a new -issue on the `GitLab issue tracker`_. To submit patches, please send a pull -request on GitLab_. Make sure to add yourself to the :ref:`contributors` file. +issue on the `GitLab issue tracker`_. To submit patches, please send a merge +request on GitLab_. .. _GitLab: https://gitlab.com/mayan-edms/mayan-edms/ .. _`GitLab issue tracker`: https://gitlab.com/mayan-edms/mayan-edms/issues