.gitignore, CODE_OF_CONDUCT and CONTRIBUTING for AGS [ skip ci]

This commit is contained in:
alandavis
2021-05-13 16:08:21 +01:00
parent 4694f3b212
commit 8310b734ec
4 changed files with 15 additions and 180 deletions

15
.gitignore vendored
View File

@@ -4,6 +4,8 @@
.classpath
.settings
.project
.gradle
.history
# Intellij
.idea/
@@ -38,3 +40,16 @@ hs_err_pid*
# Alfresco runtime
alf_data
# AGS
build.local.properties
dist
explodedDeps
local.properties
rebel.xml
rebel-remote.xml
test-output
/amps/ags/rm-automation/src/test/resources/webdriver.properties
/amps/ags/rm-community/rm-server/config/alfresco/extension
/amps/ags/rm-community/rm-community-rest-api-explorer/overlays

47
amps/ags/.gitignore vendored
View File

@@ -1,47 +0,0 @@
# General ignored files and directories
.ant-targets-build.xml
.classpath
.gradle
.idea
.project
.settings
.history
*.bak
*.eml
*.iml
*.log*
*.tmp
*.war
bin
build.local.properties
dist
explodedDeps
local.properties
rebel.xml
rebel-remote.xml
target
test-output
# /rm-community/
/rm-community/l10n
/rm-community/root
# /rm-community/rm-server/
/rm-community/rm-server/alfresco-solr.zip
/rm-community/rm-server/solr
/rm-community/rm-server/shared
# /rm-community/rm-server/config/
/rm-community/rm-server/config/alfresco-global.properties
# /rm-community/rm-server/config/alfresco/
/rm-community/rm-server/config/alfresco/extension
# /rm-enterprise/rm-automation-enterprise/
/rm-enterprise/rm-automation-enterprise/l10n
/rm-enterprise/rm-automation-enterprise/root
rm-automation/src/test/resources/webdriver.properties
/rm-community/rm-community-rest-api-explorer/overlays
/rm-enterprise/rm-enterprise-rest-api-explorer/overlays

View File

@@ -1,73 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at katalin.zanaty@alfresco.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org

View File

@@ -1,60 +0,0 @@
# How to contribute
For the details on the Records Management project see [here](https://community.alfresco.com/docs/DOC-6387-project-overview-records-management).
## Getting started
What you need to get started:
* A [GitHub](https://github.com/) account.
Useful but not necessary:
* An [Alfresco community](https://community.alfresco.com/) account - this is a good place to ask questions and find answers.
* A [Jira](https://issues.alfresco.com/jira/projects/RM/issues/?filter=allopenissues) account - Good place to look at what the team is working on;
## Making changes
We use GitHub's issues to track community contributions and issues. If you are committing a fix for a raised issue please reference the issue number in the pull request.
If you are adding in a new feature or bug fix please raise an issue in the issues tab. By raising an issue in this project you will be agreeing to the Alfresco Contribution Agreement which can be found [here](https://community.alfresco.com/docs/DOC-7070-alfresco-contribution-agreement).
When you are ready to make a change you just need to fork the [records-management](https://github.com/Alfresco/records-management) repository and then make your changes into your copy of the code.
We have a set of standards we follow when writing code. These can be found [here](https://community.alfresco.com/docs/DOC-4658-coding-standards).
When formatting your change please try not to change the format of any other code as this can make the changes difficult to spot and please make sure to use the correct line ending (we use LF).
We ask that when adding/changing code you also add/change the appropriate unit tests and that these tests all run before creating the pull request (these will be run as part of the request, it just saves time if you know they will pass beforehand).
If you are adding any user facing strings be advised these may be change after being reviewed by a member of our UA team. For UI consistency please write to these [guidelines](http://docs.alfresco.com/sites/docs.alfresco.com/files/public/docs_team/u2/Alfresco-Writing-Guide.pdf).
## Submitting changes
When you create a pull request we will run the unit tests using [Travis](https://travis-ci.org/Alfresco/records-management). If these pass a member of the team will look over the change and then assuming there are no issues will accept your change. If there are any issue we will discuss this with you using the pull request.
It really helps speed up the review process if you include a description of the change in the pull request.
After your change has been accepted you can add it to the page [here](https://community.alfresco.com/docs/DOC-5279-featured-contributions) to let other members of the community know. A community account is required to update this page.
Occasionally we may have to revert a change after it has been accepted. This will usually be caused by failing integration or UI tests. If this happens to you then feel free to get in touch for more information.
## Additional info and links
[Alfresco coding standards](https://community.alfresco.com/docs/DOC-4658-coding-standards)
[Alfresco community contributions page](https://community.alfresco.com/docs/DOC-5279-featured-contributions)
[Alfresco community site](https://community.alfresco.com/)
[Alfresco contribution agreement](https://community.alfresco.com/docs/DOC-7070-alfresco-contribution-agreement)
[Alfresco writing guidelines](http://docs.alfresco.com/sites/docs.alfresco.com/files/public/docs_team/u2/Alfresco-Writing-Guide.pdf)
[GitHub "Records Management" code repository](https://github.com/Alfresco/records-management)
[IDE settings for Eclipse and Intellij](https://github.com/Alfresco/records-management/tree/master/ide-config)
[Jira project used by GS team](https://issues.alfresco.com/jira/projects/RM/issues)
[Records Management project details](https://community.alfresco.com/docs/DOC-6387-project-overview-records-management)